Cisco-IOS-XR-ethernet-link-oam-cfg API API Reference

API generated from Cisco-IOS-XR-ethernet-link-oam-cfg@2015-11-09.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitie mapsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitie mapsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

200 OK
a1_encrypted-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold clear/encrypted\ncommunitie mapsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to configure a SNMPv2 MIB viewPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"view-name": "string", Name of the view

        
"view-inclusion": "string", MIB view to be included or excluded

        
"family": "string" MIB view family name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to configure a SNMPv2 MIB viewPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"view-name": "string", Name of the view

        
"view-inclusion": "string", MIB view to be included or excluded

        
"family": "string" MIB view family name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

200 OK
a1_views_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Class to configure a SNMPv2 MIB viewPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"view-name": "string", Name of the view

        
"view-inclusion": "string", MIB view to be included or excluded

        
"family": "string" MIB view family name

      }
    ]
  }
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"view-name": "string", Name of the view

      
"view-inclusion": "string", MIB view to be included or excluded

      
"family": "string" MIB view family name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"view-name": "string", Name of the view

      
"view-inclusion": "string", MIB view to be included or excluded

      
"family": "string" MIB view family name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK
a1_view_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"view-name": "string", Name of the view

      
"view-inclusion": "string", MIB view to be included or excluded

      
"family": "string" MIB view family name

    }
  ]
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP loggingPUTPOSTDELETEGET
    : {
SNMP logging thresholdPUTPOSTDELETEGET
      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

      
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP loggingPUTPOSTDELETEGET
    : {
SNMP logging thresholdPUTPOSTDELETEGET
      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

      
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

200 OK
a1_logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP loggingPUTPOSTDELETEGET
    : {
SNMP logging thresholdPUTPOSTDELETEGET
      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

      
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

    }
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP logging thresholdPUTPOSTDELETEGET
    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

    
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP logging thresholdPUTPOSTDELETEGET
    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

    
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

200 OK
a1_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP logging thresholdPUTPOSTDELETEGET
    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

    
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

  }
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class for SNMP administrationPUTPOSTDELETEGET
    : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    },
    : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class for SNMP administrationPUTPOSTDELETEGET
    : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    },
    : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

200 OK
a1_administration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for SNMP administrationPUTPOSTDELETEGET
    : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    },
    : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    }
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

200 OK
a1_default-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK
a1_default-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

200 OK
a1_encrypted-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : {
The heirarchy point for SNMP Agent\nconfigurationsPUTPOSTDELETEGET
    : {
SNMPv3 engineIDPUTPOSTDELETEGET
      : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"remote-engine-id": "string", engine ID octet string

            
"remote-address": "string", IP address of remote SNMP entity

            
"port": "string" UDP port number

          }
        ]
      },
      
"local": "string" engineID of the local agent

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : {
The heirarchy point for SNMP Agent\nconfigurationsPUTPOSTDELETEGET
    : {
SNMPv3 engineIDPUTPOSTDELETEGET
      : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"remote-engine-id": "string", engine ID octet string

            
"remote-address": "string", IP address of remote SNMP entity

            
"port": "string" UDP port number

          }
        ]
      },
      
"local": "string" engineID of the local agent

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

200 OK
a1_agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The heirarchy point for SNMP Agent\nconfigurationsPUTPOSTDELETEGET
    : {
SNMPv3 engineIDPUTPOSTDELETEGET
      : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"remote-engine-id": "string", engine ID octet string

            
"remote-address": "string", IP address of remote SNMP entity

            
"port": "string" UDP port number

          }
        ]
      },
      
"local": "string" engineID of the local agent

    }
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 engineIDPUTPOSTDELETEGET
    : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"remote-engine-id": "string", engine ID octet string

          
"remote-address": "string", IP address of remote SNMP entity

          
"port": "string" UDP port number

        }
      ]
    },
    
"local": "string" engineID of the local agent

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 engineIDPUTPOSTDELETEGET
    : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"remote-engine-id": "string", engine ID octet string

          
"remote-address": "string", IP address of remote SNMP entity

          
"port": "string" UDP port number

        }
      ]
    },
    
"local": "string" engineID of the local agent

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

200 OK
a1_engine-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMPv3 engineIDPUTPOSTDELETEGET
    : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"remote-engine-id": "string", engine ID octet string

          
"remote-address": "string", IP address of remote SNMP entity

          
"port": "string" UDP port number

        }
      ]
    },
    
"local": "string" engineID of the local agent

  }
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"remote-engine-id": "string", engine ID octet string

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string" UDP port number

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"remote-engine-id": "string", engine ID octet string

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string" UDP port number

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

200 OK
a1_remotes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"remote-engine-id": "string", engine ID octet string

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string" UDP port number

      }
    ]
  }
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"remote-engine-id": "string", engine ID octet string

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string" UDP port number

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"remote-engine-id": "string", engine ID octet string

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string" UDP port number

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK
a1_remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"remote-engine-id": "string", engine ID octet string

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string" UDP port number

    }
  ]
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to hold trap configurationsPUTPOSTDELETEGET
    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"

    
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"

    
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to hold trap configurationsPUTPOSTDELETEGET
    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"

    
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"

    
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

200 OK
a1_trap_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Class to hold trap configurationsPUTPOSTDELETEGET
    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"

    
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"

    
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"

  }
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP packet drop configPUTPOSTDELETEGET
    
"unknown-user": "null" Enable drop unknown user name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP packet drop configPUTPOSTDELETEGET
    
"unknown-user": "null" Enable drop unknown user name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

200 OK
a1_drop-packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP packet drop configPUTPOSTDELETEGET
    
"unknown-user": "null" Enable drop unknown user name

  }
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

200 OK
a1_ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

200 OK
a1_ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  : {
container to hold system informationPUTPOSTDELETEGET
    
"chassis-id": "string", String to uniquely identify this chassis

    
"contact": "string", identification of the contact person for this\nmanaged node

    
"location": "string" The physical location of this node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  : {
container to hold system informationPUTPOSTDELETEGET
    
"chassis-id": "string", String to uniquely identify this chassis

    
"contact": "string", identification of the contact person for this\nmanaged node

    
"location": "string" The physical location of this node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

200 OK
a1_system_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
container to hold system informationPUTPOSTDELETEGET
    
"chassis-id": "string", String to uniquely identify this chassis

    
"contact": "string", identification of the contact person for this\nmanaged node

    
"location": "string" The physical location of this node

  }
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurations
      : [
No description
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target list
      : [
No description
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurations
      : [
No description
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target list
      : [
No description
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurations
      : [
No description
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target list
      : [
No description
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of targetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
SNMP Target address configurationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"ip-address": "string" IPv4/Ipv6 address

            }
          ]
        },
        
"target-list-name": "string", Name of the target list
        : {
List of VRF Name for a target listPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"name": "string" VRF Name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of targetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
SNMP Target address configurationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"ip-address": "string" IPv4/Ipv6 address

            }
          ]
        },
        
"target-list-name": "string", Name of the target list
        : {
List of VRF Name for a target listPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"name": "string" VRF Name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

200 OK
a1_targets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of targetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
SNMP Target address configurationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"ip-address": "string" IPv4/Ipv6 address

            }
          ]
        },
        
"target-list-name": "string", Name of the target list
        : {
List of VRF Name for a target listPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"name": "string" VRF Name

            }
          ]
        }
      }
    ]
  }
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurationsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target listPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurationsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target listPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurationsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target listPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
List of VRF Name for a target listPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string" VRF Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
List of VRF Name for a target listPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string" VRF Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK
a1_vrf-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of VRF Name for a target listPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string" VRF Name

      }
    ]
  }
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string" VRF Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string" VRF Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK
a1_vrf-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string" VRF Name

    }
  ]
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
SNMP Target address configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ip-address": "string" IPv4/Ipv6 address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
SNMP Target address configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ip-address": "string" IPv4/Ipv6 address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP Target address configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ip-address": "string" IPv4/Ipv6 address

      }
    ]
  }
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ip-address": "string" IPv4/Ipv6 address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ip-address": "string" IPv4/Ipv6 address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK
a1_target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ip-address": "string" IPv4/Ipv6 address

    }
  ]
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable SNMP notificationsPUTPOSTDELETEGET
    : {
CISCO-IETF-VPLS-GENERIC-MIB notification\nconfigurationPUTPOSTDELETEGET
      
"status": "null", Enable cvplsStatusChanged notification

      
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification

    },
    : {
802.3 OAM MIB notification configurationPUTPOSTDELETEGET
      
"enable": "null" Enable CISCO-IETF-PW-MIB notifications

    },
    : {
SNMP notification configurationPUTPOSTDELETEGET
      
"authentication": "null", Enable authentication notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"warm-start": "null", Enable warm start notification

      
"cold-start": "null" Enable cold start notification

    },
    : {
CISCO-IETF-PW-MIB notification configurationPUTPOSTDELETEGET
      
"vc-up": "null", Enable cpwVcUp notification

      
"vc-down": "null", Enable cpwVcDown notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"cisco": "null" Enable Cisco format including extra varbinds

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable SNMP notificationsPUTPOSTDELETEGET
    : {
CISCO-IETF-VPLS-GENERIC-MIB notification\nconfigurationPUTPOSTDELETEGET
      
"status": "null", Enable cvplsStatusChanged notification

      
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification

    },
    : {
802.3 OAM MIB notification configurationPUTPOSTDELETEGET
      
"enable": "null" Enable CISCO-IETF-PW-MIB notifications

    },
    : {
SNMP notification configurationPUTPOSTDELETEGET
      
"authentication": "null", Enable authentication notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"warm-start": "null", Enable warm start notification

      
"cold-start": "null" Enable cold start notification

    },
    : {
CISCO-IETF-PW-MIB notification configurationPUTPOSTDELETEGET
      
"vc-up": "null", Enable cpwVcUp notification

      
"vc-down": "null", Enable cpwVcDown notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"cisco": "null" Enable Cisco format including extra varbinds

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

200 OK
a1_notification_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable SNMP notificationsPUTPOSTDELETEGET
    : {
CISCO-IETF-VPLS-GENERIC-MIB notification\nconfigurationPUTPOSTDELETEGET
      
"status": "null", Enable cvplsStatusChanged notification

      
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification

    },
    : {
802.3 OAM MIB notification configurationPUTPOSTDELETEGET
      
"enable": "null" Enable CISCO-IETF-PW-MIB notifications

    },
    : {
SNMP notification configurationPUTPOSTDELETEGET
      
"authentication": "null", Enable authentication notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"warm-start": "null", Enable warm start notification

      
"cold-start": "null" Enable cold start notification

    },
    : {
CISCO-IETF-PW-MIB notification configurationPUTPOSTDELETEGET
      
"vc-up": "null", Enable cpwVcUp notification

      
"vc-down": "null", Enable cpwVcDown notification

      
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

      
"cisco": "null" Enable Cisco format including extra varbinds

    }
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}

VPLS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Update operation of resource: vpls

a1_vpls_schema

vplsbody object

Request Content-Types: application/json
Request Example
{
  : {
CISCO-IETF-VPLS-GENERIC-MIB notification\nconfigurationPUTPOSTDELETEGET
    
"status": "null", Enable cvplsStatusChanged notification

    
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification

    
"enable": "null", Enable CISCO-IETF-VPLS-GENERIC-MIB\nnotifications

    
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPLS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Create operation of resource: vpls

a1_vpls_schema

vplsbody object

Request Content-Types: application/json
Request Example
{
  : {
CISCO-IETF-VPLS-GENERIC-MIB notification\nconfigurationPUTPOSTDELETEGET
    
"status": "null", Enable cvplsStatusChanged notification

    
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification

    
"enable": "null", Enable CISCO-IETF-VPLS-GENERIC-MIB\nnotifications

    
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPLS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Delete operation of resource: vpls

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPLS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vpls/

Retrieve operation of resource: vpls

200 OK
a1_vpls_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
CISCO-IETF-VPLS-GENERIC-MIB notification\nconfigurationPUTPOSTDELETEGET
    
"status": "null", Enable cvplsStatusChanged notification

    
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification

    
"enable": "null", Enable CISCO-IETF-VPLS-GENERIC-MIB\nnotifications

    
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification

  }
}

L2VPN - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Update operation of resource: l2vpn

a1_l2vpn_schema

l2vpnbody object

Request Content-Types: application/json
Request Example
{
  : {
CISCO-IETF-PW-MIB notification configurationPUTPOSTDELETEGET
    
"vc-up": "null", Enable cpwVcUp notification

    
"vc-down": "null", Enable cpwVcDown notification

    
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

    
"cisco": "null" Enable Cisco format including extra varbinds

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2VPN - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Create operation of resource: l2vpn

a1_l2vpn_schema

l2vpnbody object

Request Content-Types: application/json
Request Example
{
  : {
CISCO-IETF-PW-MIB notification configurationPUTPOSTDELETEGET
    
"vc-up": "null", Enable cpwVcUp notification

    
"vc-down": "null", Enable cpwVcDown notification

    
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

    
"cisco": "null" Enable Cisco format including extra varbinds

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2VPN - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Delete operation of resource: l2vpn

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2VPN - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/l2vpn/

Retrieve operation of resource: l2vpn

200 OK
a1_l2vpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
CISCO-IETF-PW-MIB notification configurationPUTPOSTDELETEGET
    
"vc-up": "null", Enable cpwVcUp notification

    
"vc-down": "null", Enable cpwVcDown notification

    
"enable": "null", Enable CISCO-IETF-PW-MIB notifications

    
"cisco": "null" Enable Cisco format including extra varbinds

  }
}

OAM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/oam/

Update operation of resource: oam

a1_oam_schema

oambody object

Request Content-Types: application/json
Request Example
{
  : {
802.3 OAM MIB notification configurationPUTPOSTDELETEGET
    
"enable": "null" Enable 802.3 OAM MIB notifications

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OAM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/oam/

Create operation of resource: oam

a1_oam_schema

oambody object

Request Content-Types: application/json
Request Example
{
  : {
802.3 OAM MIB notification configurationPUTPOSTDELETEGET
    
"enable": "null" Enable 802.3 OAM MIB notifications

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OAM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/oam/

Delete operation of resource: oam

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OAM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/oam/

Retrieve operation of resource: oam

200 OK
a1_oam_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
802.3 OAM MIB notification configurationPUTPOSTDELETEGET
    
"enable": "null" Enable 802.3 OAM MIB notifications

  }
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure properties of the trap correlatorPUTPOSTDELETEGET
    : {
Table of configured rulesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Table of configured non-rootcausePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

          
"name": "string" Ruleset name

        }
      ]
    },
    : {
Table of configured rulesetsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          
"name": "string", Ruleset name
          : {
Table of configured rulenamesPUTPOSTDELETEGET
            : [
Rule namePUTPOSTDELETEGET
              {
                
"rulename": "string" Rule name

              }
            ]
          }
        }
      ]
    },
    
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure properties of the trap correlatorPUTPOSTDELETEGET
    : {
Table of configured rulesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Table of configured non-rootcausePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

          
"name": "string" Ruleset name

        }
      ]
    },
    : {
Table of configured rulesetsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          
"name": "string", Ruleset name
          : {
Table of configured rulenamesPUTPOSTDELETEGET
            : [
Rule namePUTPOSTDELETEGET
              {
                
"rulename": "string" Rule name

              }
            ]
          }
        }
      ]
    },
    
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

200 OK
a1_correlator_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure properties of the trap correlatorPUTPOSTDELETEGET
    : {
Table of configured rulesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Table of configured non-rootcausePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

          
"name": "string" Ruleset name

        }
      ]
    },
    : {
Table of configured rulesetsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          
"name": "string", Ruleset name
          : {
Table of configured rulenamesPUTPOSTDELETEGET
            : [
Rule namePUTPOSTDELETEGET
              {
                
"rulename": "string" Rule name

              }
            ]
          }
        }
      ]
    },
    
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"

  }
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Table of configured non-rootcausePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

        
"name": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Table of configured non-rootcausePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

        
"name": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

200 OK
a1_rules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rulesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Table of configured non-rootcausePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

        
"name": "string" Rule name

      }
    ]
  }
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Table of configured non-rootcausePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

      
"name": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Table of configured non-rootcausePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

      
"name": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

200 OK
a1_rule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Table of configured non-rootcausePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"

      
"name": "string" Rule name

    }
  ]
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of rootcause trap (dotted decimal)

        
"created": "null" Create rootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of rootcause trap (dotted decimal)

        
"created": "null" Create rootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

200 OK
a1_root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of rootcause trap (dotted decimal)

        
"created": "null" Create rootcause

      }
    ]
  }
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of rootcause trap (dotted decimal)

      
"created": "null" Create rootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of rootcause trap (dotted decimal)

      
"created": "null" Create rootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of rootcause trap (dotted decimal)

      
"created": "null" Create rootcause

    }
  ]
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured non-rootcausePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of nonrootcause trap (dotted decimal)

        
"created": "null" Create nonrootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured non-rootcausePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of nonrootcause trap (dotted decimal)

        
"created": "null" Create nonrootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

200 OK
a1_non-root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured non-rootcausePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of nonrootcause trap (dotted decimal)

        
"created": "null" Create nonrootcause

      }
    ]
  }
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of nonrootcause trap (dotted decimal)

      
"created": "null" Create nonrootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of nonrootcause trap (dotted decimal)

      
"created": "null" Create nonrootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_non-root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of nonrootcause trap (dotted decimal)

      
"created": "null" Create nonrootcause

    }
  ]
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        
"name": "string", Ruleset name
        : {
Table of configured rulenamesPUTPOSTDELETEGET
          : [
Rule namePUTPOSTDELETEGET
            {
              
"rulename": "string" Rule name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        
"name": "string", Ruleset name
        : {
Table of configured rulenamesPUTPOSTDELETEGET
          : [
Rule namePUTPOSTDELETEGET
            {
              
"rulename": "string" Rule name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

200 OK
a1_rule-sets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rulesetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        
"name": "string", Ruleset name
        : {
Table of configured rulenamesPUTPOSTDELETEGET
          : [
Rule namePUTPOSTDELETEGET
            {
              
"rulename": "string" Rule name

            }
          ]
        }
      }
    ]
  }
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      
"name": "string", Ruleset name
      : {
Table of configured rulenamesPUTPOSTDELETEGET
        : [
Rule namePUTPOSTDELETEGET
          {
            
"rulename": "string" Rule name

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      
"name": "string", Ruleset name
      : {
Table of configured rulenamesPUTPOSTDELETEGET
        : [
Rule namePUTPOSTDELETEGET
          {
            
"rulename": "string" Rule name

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

200 OK
a1_rule-set_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      
"name": "string", Ruleset name
      : {
Table of configured rulenamesPUTPOSTDELETEGET
        : [
Rule namePUTPOSTDELETEGET
          {
            
"rulename": "string" Rule name

          }
        ]
      }
    }
  ]
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulenamesPUTPOSTDELETEGET
    : [
Rule namePUTPOSTDELETEGET
      {
        
"rulename": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulenamesPUTPOSTDELETEGET
    : [
Rule namePUTPOSTDELETEGET
      {
        
"rulename": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

200 OK
a1_rulenames_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rulenamesPUTPOSTDELETEGET
    : [
Rule namePUTPOSTDELETEGET
      {
        
"rulename": "string" Rule name

      }
    ]
  }
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  : [
Rule namePUTPOSTDELETEGET
    {
      
"rulename": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  : [
Rule namePUTPOSTDELETEGET
    {
      
"rulename": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK
a1_rulename_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
Rule namePUTPOSTDELETEGET
    {
      
"rulename": "string" Rule name

    }
  ]
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP bulk stats configuration commandsPUTPOSTDELETEGET
    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
    : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"retry": "integer", Number of transmission retries
range: "0..100"
          : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"schema-name": "string" The name of the schema

              }
            ]
          },
          
"format": "string", Format of the bulk data file

          
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

          
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

          
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

          
"enable": "null", Start Data Collection for this Configuration

          
"transfer-name": "string", Name of bulk transfer

          
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

          
"type": "null", Configure schema name

          
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

        }
      ]
    },
    : {
Configure an object ListPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"object-list-name": "string", Name of the object List
          : {
Configure an object ListPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"oid": "string" Object name or OID 

              }
            ]
          },
          
"type": "null" Configure schema name

        }
      ]
    },
    : {
Configure schema definitionPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"schema-name": "string", The name of the schema
          : {
Instance of the schemaPUTPOSTDELETEGET
            
"end": "string", End Instance OID for repetition

            
"sub-interface": "boolean", Include all the subinterface

            
"start": "string", Start Instance OID for repetition

            
"max": "integer", Max value of Instance repetition

            
"instance": "string", Instance of the schema

            
"type": "string" Configure schema name

          },
          
"type": "null", Configure schema name

          
"schema-object-list": "string", Name of an object List

          
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP bulk stats configuration commandsPUTPOSTDELETEGET
    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
    : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"retry": "integer", Number of transmission retries
range: "0..100"
          : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"schema-name": "string" The name of the schema

              }
            ]
          },
          
"format": "string", Format of the bulk data file

          
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

          
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

          
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

          
"enable": "null", Start Data Collection for this Configuration

          
"transfer-name": "string", Name of bulk transfer

          
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

          
"type": "null", Configure schema name

          
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

        }
      ]
    },
    : {
Configure an object ListPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"object-list-name": "string", Name of the object List
          : {
Configure an object ListPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"oid": "string" Object name or OID 

              }
            ]
          },
          
"type": "null" Configure schema name

        }
      ]
    },
    : {
Configure schema definitionPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"schema-name": "string", The name of the schema
          : {
Instance of the schemaPUTPOSTDELETEGET
            
"end": "string", End Instance OID for repetition

            
"sub-interface": "boolean", Include all the subinterface

            
"start": "string", Start Instance OID for repetition

            
"max": "integer", Max value of Instance repetition

            
"instance": "string", Instance of the schema

            
"type": "string" Configure schema name

          },
          
"type": "null", Configure schema name

          
"schema-object-list": "string", Name of an object List

          
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

200 OK
a1_bulk-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP bulk stats configuration commandsPUTPOSTDELETEGET
    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
    : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"retry": "integer", Number of transmission retries
range: "0..100"
          : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"schema-name": "string" The name of the schema

              }
            ]
          },
          
"format": "string", Format of the bulk data file

          
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

          
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

          
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

          
"enable": "null", Start Data Collection for this Configuration

          
"transfer-name": "string", Name of bulk transfer

          
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

          
"type": "null", Configure schema name

          
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

        }
      ]
    },
    : {
Configure an object ListPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"object-list-name": "string", Name of the object List
          : {
Configure an object ListPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"oid": "string" Object name or OID 

              }
            ]
          },
          
"type": "null" Configure schema name

        }
      ]
    },
    : {
Configure schema definitionPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"schema-name": "string", The name of the schema
          : {
Instance of the schemaPUTPOSTDELETEGET
            
"end": "string", End Instance OID for repetition

            
"sub-interface": "boolean", Include all the subinterface

            
"start": "string", Start Instance OID for repetition

            
"max": "integer", Max value of Instance repetition

            
"instance": "string", Instance of the schema

            
"type": "string" Configure schema name

          },
          
"type": "null", Configure schema name

          
"schema-object-list": "string", Name of an object List

          
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

        }
      ]
    }
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure schema definitionPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string", The name of the schema
        : {
Instance of the schemaPUTPOSTDELETEGET
          
"end": "string", End Instance OID for repetition

          
"sub-interface": "boolean", Include all the subinterface

          
"start": "string", Start Instance OID for repetition

          
"max": "integer", Max value of Instance repetition

          
"instance": "string", Instance of the schema

          
"type": "string" Configure schema name

        },
        
"type": "null", Configure schema name

        
"schema-object-list": "string", Name of an object List

        
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure schema definitionPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string", The name of the schema
        : {
Instance of the schemaPUTPOSTDELETEGET
          
"end": "string", End Instance OID for repetition

          
"sub-interface": "boolean", Include all the subinterface

          
"start": "string", Start Instance OID for repetition

          
"max": "integer", Max value of Instance repetition

          
"instance": "string", Instance of the schema

          
"type": "string" Configure schema name

        },
        
"type": "null", Configure schema name

        
"schema-object-list": "string", Name of an object List

        
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

200 OK
a1_schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure schema definitionPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string", The name of the schema
        : {
Instance of the schemaPUTPOSTDELETEGET
          
"end": "string", End Instance OID for repetition

          
"sub-interface": "boolean", Include all the subinterface

          
"start": "string", Start Instance OID for repetition

          
"max": "integer", Max value of Instance repetition

          
"instance": "string", Instance of the schema

          
"type": "string" Configure schema name

        },
        
"type": "null", Configure schema name

        
"schema-object-list": "string", Name of an object List

        
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

      }
    ]
  }
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string", The name of the schema
      : {
Instance of the schemaPUTPOSTDELETEGET
        
"end": "string", End Instance OID for repetition

        
"sub-interface": "boolean", Include all the subinterface

        
"start": "string", Start Instance OID for repetition

        
"max": "integer", Max value of Instance repetition

        
"instance": "string", Instance of the schema

        
"type": "string" Configure schema name

      },
      
"type": "null", Configure schema name

      
"schema-object-list": "string", Name of an object List

      
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string", The name of the schema
      : {
Instance of the schemaPUTPOSTDELETEGET
        
"end": "string", End Instance OID for repetition

        
"sub-interface": "boolean", Include all the subinterface

        
"start": "string", Start Instance OID for repetition

        
"max": "integer", Max value of Instance repetition

        
"instance": "string", Instance of the schema

        
"type": "string" Configure schema name

      },
      
"type": "null", Configure schema name

      
"schema-object-list": "string", Name of an object List

      
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK
a1_schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string", The name of the schema
      : {
Instance of the schemaPUTPOSTDELETEGET
        
"end": "string", End Instance OID for repetition

        
"sub-interface": "boolean", Include all the subinterface

        
"start": "string", Start Instance OID for repetition

        
"max": "integer", Max value of Instance repetition

        
"instance": "string", Instance of the schema

        
"type": "string" Configure schema name

      },
      
"type": "null", Configure schema name

      
"schema-object-list": "string", Name of an object List

      
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

    }
  ]
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : {
Instance of the schemaPUTPOSTDELETEGET
    
"end": "string", End Instance OID for repetition

    
"sub-interface": "boolean", Include all the subinterface

    
"start": "string", Start Instance OID for repetition

    
"max": "integer", Max value of Instance repetition

    
"instance": "string", Instance of the schema

    
"type": "string" Type of the instance

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : {
Instance of the schemaPUTPOSTDELETEGET
    
"end": "string", End Instance OID for repetition

    
"sub-interface": "boolean", Include all the subinterface

    
"start": "string", Start Instance OID for repetition

    
"max": "integer", Max value of Instance repetition

    
"instance": "string", Instance of the schema

    
"type": "string" Type of the instance

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK
a1_instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Instance of the schemaPUTPOSTDELETEGET
    
"end": "string", End Instance OID for repetition

    
"sub-interface": "boolean", Include all the subinterface

    
"start": "string", Start Instance OID for repetition

    
"max": "integer", Max value of Instance repetition

    
"instance": "string", Instance of the schema

    
"type": "string" Type of the instance

  }
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
        : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"schema-name": "string" Schema that contains objects to be\ncollected

            }
          ]
        },
        
"format": "string", Format of the bulk data file

        
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

        
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

        
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

        
"enable": "null", Start Data Collection for this Configuration

        
"transfer-name": "string", Name of bulk transfer

        
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

        
"type": "null", Configure transfer list name

        
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
        : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"schema-name": "string" Schema that contains objects to be\ncollected

            }
          ]
        },
        
"format": "string", Format of the bulk data file

        
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

        
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

        
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

        
"enable": "null", Start Data Collection for this Configuration

        
"transfer-name": "string", Name of bulk transfer

        
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

        
"type": "null", Configure transfer list name

        
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

200 OK
a1_transfers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
        : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"schema-name": "string" Schema that contains objects to be\ncollected

            }
          ]
        },
        
"format": "string", Format of the bulk data file

        
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

        
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

        
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

        
"enable": "null", Start Data Collection for this Configuration

        
"transfer-name": "string", Name of bulk transfer

        
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

        
"type": "null", Configure transfer list name

        
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

      }
    ]
  }
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
      : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"schema-name": "string" Schema that contains objects to be\ncollected

          }
        ]
      },
      
"format": "string", Format of the bulk data file

      
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

      
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

      
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

      
"enable": "null", Start Data Collection for this Configuration

      
"transfer-name": "string", Name of bulk transfer

      
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

      
"type": "null", Configure transfer list name

      
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
      : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"schema-name": "string" Schema that contains objects to be\ncollected

          }
        ]
      },
      
"format": "string", Format of the bulk data file

      
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

      
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

      
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

      
"enable": "null", Start Data Collection for this Configuration

      
"transfer-name": "string", Name of bulk transfer

      
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

      
"type": "null", Configure transfer list name

      
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
      : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"schema-name": "string" Schema that contains objects to be\ncollected

          }
        ]
      },
      
"format": "string", Format of the bulk data file

      
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"

      
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

      
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

      
"enable": "null", Start Data Collection for this Configuration

      
"transfer-name": "string", Name of bulk transfer

      
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

      
"type": "null", Configure transfer list name

      
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

    }
  ]
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string" Schema that contains objects to be\ncollected

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string" Schema that contains objects to be\ncollected

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer-schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string" Schema that contains objects to be\ncollected

      }
    ]
  }
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string" Schema that contains objects to be\ncollected

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string" Schema that contains objects to be\ncollected

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK
a1_transfer-schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string" Schema that contains objects to be\ncollected

    }
  ]
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted community mapPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted community mapPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

200 OK
a1_default-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold unencrpted community mapPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK
a1_default-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  : {
Set overload control params for handling\nincoming messagesPUTPOSTDELETEGET
    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"

    
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  : {
Set overload control params for handling\nincoming messagesPUTPOSTDELETEGET
    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"

    
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

200 OK
a1_overload-control_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Set overload control params for handling\nincoming messagesPUTPOSTDELETEGET
    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"

    
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"

  }
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP timeoutsPUTPOSTDELETEGET
    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"

    
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"

    
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"

    
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP timeoutsPUTPOSTDELETEGET
    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"

    
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"

    
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"

    
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

200 OK
a1_timeouts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP timeoutsPUTPOSTDELETEGET
    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"

    
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"

    
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"

    
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"

  }
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a user who can access the SNMP enginePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"v6acl-type": "string", Access-list type

        
"group-name": "string", Group to which the user belongs

        
"v6-access-list": "string", Ipv6 Access-list name

        
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

        
"owner": "string", The system access either SDROwner or\nSystemOwner

        
"v4acl-type": "string", Access-list type

        
"privacy-password": "string", The privacy password

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string", UDP port number

        
"user-name": "string", Name of the user

        
"algorithm": "string", The algorithm used md5 or sha

        
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

        
"authentication-password": "string", The authentication password

        
"version": "string", SNMP version to be used. v1,v2c or v3

        
"v4-access-list": "string", Ipv4 Access-list name

        
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a user who can access the SNMP enginePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"v6acl-type": "string", Access-list type

        
"group-name": "string", Group to which the user belongs

        
"v6-access-list": "string", Ipv6 Access-list name

        
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

        
"owner": "string", The system access either SDROwner or\nSystemOwner

        
"v4acl-type": "string", Access-list type

        
"privacy-password": "string", The privacy password

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string", UDP port number

        
"user-name": "string", Name of the user

        
"algorithm": "string", The algorithm used md5 or sha

        
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

        
"authentication-password": "string", The authentication password

        
"version": "string", SNMP version to be used. v1,v2c or v3

        
"v4-access-list": "string", Ipv4 Access-list name

        
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

200 OK
a1_users_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Define a user who can access the SNMP enginePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"v6acl-type": "string", Access-list type

        
"group-name": "string", Group to which the user belongs

        
"v6-access-list": "string", Ipv6 Access-list name

        
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

        
"owner": "string", The system access either SDROwner or\nSystemOwner

        
"v4acl-type": "string", Access-list type

        
"privacy-password": "string", The privacy password

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string", UDP port number

        
"user-name": "string", Name of the user

        
"algorithm": "string", The algorithm used md5 or sha

        
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

        
"authentication-password": "string", The authentication password

        
"version": "string", SNMP version to be used. v1,v2c or v3

        
"v4-access-list": "string", Ipv4 Access-list name

        
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

      }
    ]
  }
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"v6acl-type": "string", Access-list type

      
"group-name": "string", Group to which the user belongs

      
"v6-access-list": "string", Ipv6 Access-list name

      
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

      
"owner": "string", The system access either SDROwner or\nSystemOwner

      
"v4acl-type": "string", Access-list type

      
"privacy-password": "string", The privacy password

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string", UDP port number

      
"user-name": "string", Name of the user

      
"algorithm": "string", The algorithm used md5 or sha

      
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

      
"authentication-password": "string", The authentication password

      
"version": "string", SNMP version to be used. v1,v2c or v3

      
"v4-access-list": "string", Ipv4 Access-list name

      
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"v6acl-type": "string", Access-list type

      
"group-name": "string", Group to which the user belongs

      
"v6-access-list": "string", Ipv6 Access-list name

      
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

      
"owner": "string", The system access either SDROwner or\nSystemOwner

      
"v4acl-type": "string", Access-list type

      
"privacy-password": "string", The privacy password

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string", UDP port number

      
"user-name": "string", Name of the user

      
"algorithm": "string", The algorithm used md5 or sha

      
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

      
"authentication-password": "string", The authentication password

      
"version": "string", SNMP version to be used. v1,v2c or v3

      
"v4-access-list": "string", Ipv4 Access-list name

      
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

200 OK
a1_user_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"v6acl-type": "string", Access-list type

      
"group-name": "string", Group to which the user belongs

      
"v6-access-list": "string", Ipv6 Access-list name

      
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

      
"owner": "string", The system access either SDROwner or\nSystemOwner

      
"v4acl-type": "string", Access-list type

      
"privacy-password": "string", The privacy password

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string", UDP port number

      
"user-name": "string", Name of the user

      
"algorithm": "string", The algorithm used md5 or sha

      
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

      
"authentication-password": "string", The authentication password

      
"version": "string", SNMP version to be used. v1,v2c or v3

      
"v4-access-list": "string", Ipv4 Access-list name

      
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

    }
  ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP VRF configuration commandsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
List of Context NamesPUTPOSTDELETEGET
          : [
SNMP context feature typePUTPOSTDELETEGET
            {
              
"context-name": "string" Context Name

            }
          ]
        },
        : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
                : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                },
                : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                }
              },
              
"ip-address": "string", IP address of SNMP notification host
              : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            }
          ]
        },
        
"name": "string", VRF name
        : {
List of context namesPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"context-mapping-name": "string", Context mapping name

              
"vrf-name": "string", VRF name associated with the context

              
"topology-name": "string", Topology name associated with the context

              
"context": "string", SNMP context feature type

              
"instance-name": "string" OSPF protocol instance

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP VRF configuration commandsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
List of Context NamesPUTPOSTDELETEGET
          : [
SNMP context feature typePUTPOSTDELETEGET
            {
              
"context-name": "string" Context Name

            }
          ]
        },
        : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
                : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                },
                : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                }
              },
              
"ip-address": "string", IP address of SNMP notification host
              : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            }
          ]
        },
        
"name": "string", VRF name
        : {
List of context namesPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"context-mapping-name": "string", Context mapping name

              
"vrf-name": "string", VRF name associated with the context

              
"topology-name": "string", Topology name associated with the context

              
"context": "string", SNMP context feature type

              
"instance-name": "string" OSPF protocol instance

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

200 OK
a1_vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP VRF configuration commandsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
List of Context NamesPUTPOSTDELETEGET
          : [
SNMP context feature typePUTPOSTDELETEGET
            {
              
"context-name": "string" Context Name

            }
          ]
        },
        : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
                : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                },
                : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                }
              },
              
"ip-address": "string", IP address of SNMP notification host
              : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            }
          ]
        },
        
"name": "string", VRF name
        : {
List of context namesPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"context-mapping-name": "string", Context mapping name

              
"vrf-name": "string", VRF name associated with the context

              
"topology-name": "string", Topology name associated with the context

              
"context": "string", SNMP context feature type

              
"instance-name": "string" OSPF protocol instance

            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
List of Context NamesPUTPOSTDELETEGET
        : [
SNMP context feature typePUTPOSTDELETEGET
          {
            
"context-name": "string" Context Name

          }
        ]
      },
      : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            },
            : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
              : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            },
            
"ip-address": "string", IP address of SNMP notification host
            : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            }
          }
        ]
      },
      
"name": "string", VRF name
      : {
List of context namesPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"context-mapping-name": "string", Context mapping name

            
"vrf-name": "string", VRF name associated with the context

            
"topology-name": "string", Topology name associated with the context

            
"context": "string", SNMP context feature type

            
"instance-name": "string" OSPF protocol instance

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
List of Context NamesPUTPOSTDELETEGET
        : [
SNMP context feature typePUTPOSTDELETEGET
          {
            
"context-name": "string" Context Name

          }
        ]
      },
      : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            },
            : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
              : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            },
            
"ip-address": "string", IP address of SNMP notification host
            : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            }
          }
        ]
      },
      
"name": "string", VRF name
      : {
List of context namesPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"context-mapping-name": "string", Context mapping name

            
"vrf-name": "string", VRF name associated with the context

            
"topology-name": "string", Topology name associated with the context

            
"context": "string", SNMP context feature type

            
"instance-name": "string" OSPF protocol instance

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK
a1_vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
List of Context NamesPUTPOSTDELETEGET
        : [
SNMP context feature typePUTPOSTDELETEGET
          {
            
"context-name": "string" Context Name

          }
        ]
      },
      : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            },
            : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
              : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            },
            
"ip-address": "string", IP address of SNMP notification host
            : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            }
          }
        ]
      },
      
"name": "string", VRF name
      : {
List of context namesPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"context-mapping-name": "string", Context mapping name

            
"vrf-name": "string", VRF name associated with the context

            
"topology-name": "string", Topology name associated with the context

            
"context": "string", SNMP context feature type

            
"instance-name": "string" OSPF protocol instance

          }
        ]
      }
    }
  ]
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a User Security Model groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string", Name of the group

        
"write-view": "string", write view name

        
"snmp-version": "string", snmp version

        
"context-name": "string", Context name

        
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"read-view": "string", read view name

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string", Ipv4 Access-list name

        
"notify-view": "string" notify view name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a User Security Model groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string", Name of the group

        
"write-view": "string", write view name

        
"snmp-version": "string", snmp version

        
"context-name": "string", Context name

        
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"read-view": "string", read view name

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string", Ipv4 Access-list name

        
"notify-view": "string" notify view name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

200 OK
a1_groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Define a User Security Model groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string", Name of the group

        
"write-view": "string", write view name

        
"snmp-version": "string", snmp version

        
"context-name": "string", Context name

        
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"read-view": "string", read view name

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string", Ipv4 Access-list name

        
"notify-view": "string" notify view name

      }
    ]
  }
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string", Name of the group

      
"write-view": "string", write view name

      
"snmp-version": "string", snmp version

      
"context-name": "string", Context name

      
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

      
"v6acl-type": "string", Access-list type

      
"v6-access-list": "string", Ipv6 Access-list name

      
"read-view": "string", read view name

      
"v4acl-type": "string", Access-list type

      
"v4-access-list": "string", Ipv4 Access-list name

      
"notify-view": "string" notify view name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string", Name of the group

      
"write-view": "string", write view name

      
"snmp-version": "string", snmp version

      
"context-name": "string", Context name

      
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

      
"v6acl-type": "string", Access-list type

      
"v6-access-list": "string", Ipv6 Access-list name

      
"read-view": "string", read view name

      
"v4acl-type": "string", Access-list type

      
"v4-access-list": "string", Ipv4 Access-list name

      
"notify-view": "string" notify view name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

200 OK
a1_group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string", Name of the group

      
"write-view": "string", write view name

      
"snmp-version": "string", snmp version

      
"context-name": "string", Context name

      
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

      
"v6acl-type": "string", Access-list type

      
"v6-access-list": "string", Ipv6 Access-list name

      
"read-view": "string", read view name

      
"v4acl-type": "string", Access-list type

      
"v4-access-list": "string", Ipv4 Access-list name

      
"notify-view": "string" notify view name

    }
  ]
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK
a1_mib_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

ETHERNET-FEATURES - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Update operation of resource: ethernet-features

a2_ethernet-features_schema

ethernet-featuresbody object

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
    : {
Egress Filtering ConfigurationPUTPOSTDELETEGET
      
"egress-filtering-default-on": "null" Whether Egress Filtering is on by default

    },
    : {
Ethernet Link OAM Global ConfigurationPUTPOSTDELETEGET
      : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
        : [
nonePUTPOSTDELETEGET
          {
            : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
              : {
Frame-seconds event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Symbol-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              },
              
"monitoring": "boolean", Enable or disable monitoring
              : {
Frame event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Frame-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              }
            },
            
"profile": "string", none

            
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

            
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

            
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

            
"mode": "string", Possible required OAM modes

            
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
            : {
Configure action parametersPUTPOSTDELETEGET
              
"dying-gasp": "string", Action to perform when a dying gasp occurs

              
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

              
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

              
"session-up": "string", Action to perform when a session comes up

              
"link-fault": "string", Action to perform when a link fault message\nis received

              
"critical-event": "string", Action to perform when a critical event\noccurs

              
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

              
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

              
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

              
"session-down": "string" Action to perform when a session goes down

            },
            : {
Configure remote requirement parametersPUTPOSTDELETEGET
              
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

              
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

              
"mode": "string", Possible required OAM modes

              
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

            },
            
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Create operation of resource: ethernet-features

a2_ethernet-features_schema

ethernet-featuresbody object

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
    : {
Egress Filtering ConfigurationPUTPOSTDELETEGET
      
"egress-filtering-default-on": "null" Whether Egress Filtering is on by default

    },
    : {
Ethernet Link OAM Global ConfigurationPUTPOSTDELETEGET
      : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
        : [
nonePUTPOSTDELETEGET
          {
            : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
              : {
Frame-seconds event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Symbol-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              },
              
"monitoring": "boolean", Enable or disable monitoring
              : {
Frame event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Frame-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              }
            },
            
"profile": "string", none

            
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

            
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

            
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

            
"mode": "string", Possible required OAM modes

            
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
            : {
Configure action parametersPUTPOSTDELETEGET
              
"dying-gasp": "string", Action to perform when a dying gasp occurs

              
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

              
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

              
"session-up": "string", Action to perform when a session comes up

              
"link-fault": "string", Action to perform when a link fault message\nis received

              
"critical-event": "string", Action to perform when a critical event\noccurs

              
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

              
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

              
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

              
"session-down": "string" Action to perform when a session goes down

            },
            : {
Configure remote requirement parametersPUTPOSTDELETEGET
              
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

              
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

              
"mode": "string", Possible required OAM modes

              
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

            },
            
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Delete operation of resource: ethernet-features

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/

Retrieve operation of resource: ethernet-features

200 OK
a2_ethernet-features_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
    : {
Egress Filtering ConfigurationPUTPOSTDELETEGET
      
"egress-filtering-default-on": "null" Whether Egress Filtering is on by default

    },
    : {
Ethernet Link OAM Global ConfigurationPUTPOSTDELETEGET
      : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
        : [
nonePUTPOSTDELETEGET
          {
            : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
              : {
Frame-seconds event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Symbol-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              },
              
"monitoring": "boolean", Enable or disable monitoring
              : {
Frame event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Frame-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              }
            },
            
"profile": "string", none

            
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

            
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

            
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

            
"mode": "string", Possible required OAM modes

            
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
            : {
Configure action parametersPUTPOSTDELETEGET
              
"dying-gasp": "string", Action to perform when a dying gasp occurs

              
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

              
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

              
"session-up": "string", Action to perform when a session comes up

              
"link-fault": "string", Action to perform when a link fault message\nis received

              
"critical-event": "string", Action to perform when a critical event\noccurs

              
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

              
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

              
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

              
"session-down": "string" Action to perform when a session goes down

            },
            : {
Configure remote requirement parametersPUTPOSTDELETEGET
              
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

              
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

              
"mode": "string", Possible required OAM modes

              
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

            },
            
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

          }
        ]
      }
    }
  }
}

EGRESS-FILTERING - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Update operation of resource: egress-filtering

a2_egress-filtering_schema

egress-filteringbody object

Request Content-Types: application/json
Request Example
{
  : {
Egress Filtering ConfigurationPUTPOSTDELETEGET
    
"egress-filtering-default-on": "null" Whether Egress Filtering is on by default

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EGRESS-FILTERING - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Create operation of resource: egress-filtering

a2_egress-filtering_schema

egress-filteringbody object

Request Content-Types: application/json
Request Example
{
  : {
Egress Filtering ConfigurationPUTPOSTDELETEGET
    
"egress-filtering-default-on": "null" Whether Egress Filtering is on by default

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EGRESS-FILTERING - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Delete operation of resource: egress-filtering

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EGRESS-FILTERING - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/egress-filtering/

Retrieve operation of resource: egress-filtering

200 OK
a2_egress-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Egress Filtering ConfigurationPUTPOSTDELETEGET
    
"egress-filtering-default-on": "null" Whether Egress Filtering is on by default

  }
}

ETHER-LINK-OAM - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/

Update operation of resource: ether-link-oam

a2_ether-link-oam_schema

ether-link-oambody object

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Link OAM Global ConfigurationPUTPOSTDELETEGET
    : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
      : [
nonePUTPOSTDELETEGET
        {
          : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
            : {
Frame-seconds event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Symbol-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            },
            
"monitoring": "boolean", Enable or disable monitoring
            : {
Frame event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Frame-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            }
          },
          
"profile": "string", none

          
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

          
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

          
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

          
"mode": "string", Possible required OAM modes

          
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
          : {
Configure action parametersPUTPOSTDELETEGET
            
"dying-gasp": "string", Action to perform when a dying gasp occurs

            
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

            
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

            
"session-up": "string", Action to perform when a session comes up

            
"link-fault": "string", Action to perform when a link fault message\nis received

            
"critical-event": "string", Action to perform when a critical event\noccurs

            
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

            
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

            
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

            
"session-down": "string" Action to perform when a session goes down

          },
          : {
Configure remote requirement parametersPUTPOSTDELETEGET
            
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

            
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

            
"mode": "string", Possible required OAM modes

            
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

          },
          
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHER-LINK-OAM - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/

Create operation of resource: ether-link-oam

a2_ether-link-oam_schema

ether-link-oambody object

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Link OAM Global ConfigurationPUTPOSTDELETEGET
    : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
      : [
nonePUTPOSTDELETEGET
        {
          : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
            : {
Frame-seconds event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Symbol-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            },
            
"monitoring": "boolean", Enable or disable monitoring
            : {
Frame event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Frame-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            }
          },
          
"profile": "string", none

          
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

          
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

          
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

          
"mode": "string", Possible required OAM modes

          
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
          : {
Configure action parametersPUTPOSTDELETEGET
            
"dying-gasp": "string", Action to perform when a dying gasp occurs

            
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

            
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

            
"session-up": "string", Action to perform when a session comes up

            
"link-fault": "string", Action to perform when a link fault message\nis received

            
"critical-event": "string", Action to perform when a critical event\noccurs

            
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

            
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

            
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

            
"session-down": "string" Action to perform when a session goes down

          },
          : {
Configure remote requirement parametersPUTPOSTDELETEGET
            
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

            
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

            
"mode": "string", Possible required OAM modes

            
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

          },
          
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHER-LINK-OAM - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/

Delete operation of resource: ether-link-oam

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHER-LINK-OAM - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/

Retrieve operation of resource: ether-link-oam

200 OK
a2_ether-link-oam_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Ethernet Link OAM Global ConfigurationPUTPOSTDELETEGET
    : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
      : [
nonePUTPOSTDELETEGET
        {
          : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
            : {
Frame-seconds event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Symbol-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            },
            
"monitoring": "boolean", Enable or disable monitoring
            : {
Frame event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Frame-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            }
          },
          
"profile": "string", none

          
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

          
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

          
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

          
"mode": "string", Possible required OAM modes

          
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
          : {
Configure action parametersPUTPOSTDELETEGET
            
"dying-gasp": "string", Action to perform when a dying gasp occurs

            
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

            
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

            
"session-up": "string", Action to perform when a session comes up

            
"link-fault": "string", Action to perform when a link fault message\nis received

            
"critical-event": "string", Action to perform when a critical event\noccurs

            
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

            
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

            
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

            
"session-down": "string" Action to perform when a session goes down

          },
          : {
Configure remote requirement parametersPUTPOSTDELETEGET
            
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

            
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

            
"mode": "string", Possible required OAM modes

            
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

          },
          
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

        }
      ]
    }
  }
}

PROFILES - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/

Update operation of resource: profiles

a2_profiles_schema

profilesbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
    : [
nonePUTPOSTDELETEGET
      {
        : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
          : {
Frame-seconds event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            },
            
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          },
          : {
Symbol-period event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"units": "string", The units to use for this window

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            : {
Size of the frame-period windowPUTPOSTDELETEGET
              
"units": "string", The units to use for this window

              
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

            }
          },
          
"monitoring": "boolean", Enable or disable monitoring
          : {
Frame event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          },
          : {
Frame-period event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"units": "string", The units to use for this window

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            : {
Size of the frame-period windowPUTPOSTDELETEGET
              
"units": "string", The units to use for this window

              
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

            }
          }
        },
        
"profile": "string", none

        
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

        
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

        
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

        
"mode": "string", Possible required OAM modes

        
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
        : {
Configure action parametersPUTPOSTDELETEGET
          
"dying-gasp": "string", Action to perform when a dying gasp occurs

          
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

          
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

          
"session-up": "string", Action to perform when a session comes up

          
"link-fault": "string", Action to perform when a link fault message\nis received

          
"critical-event": "string", Action to perform when a critical event\noccurs

          
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

          
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

          
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

          
"session-down": "string" Action to perform when a session goes down

        },
        : {
Configure remote requirement parametersPUTPOSTDELETEGET
          
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

          
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

          
"mode": "string", Possible required OAM modes

          
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

        },
        
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/

Create operation of resource: profiles

a2_profiles_schema

profilesbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
    : [
nonePUTPOSTDELETEGET
      {
        : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
          : {
Frame-seconds event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            },
            
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          },
          : {
Symbol-period event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"units": "string", The units to use for this window

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            : {
Size of the frame-period windowPUTPOSTDELETEGET
              
"units": "string", The units to use for this window

              
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

            }
          },
          
"monitoring": "boolean", Enable or disable monitoring
          : {
Frame event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          },
          : {
Frame-period event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"units": "string", The units to use for this window

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            : {
Size of the frame-period windowPUTPOSTDELETEGET
              
"units": "string", The units to use for this window

              
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

            }
          }
        },
        
"profile": "string", none

        
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

        
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

        
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

        
"mode": "string", Possible required OAM modes

        
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
        : {
Configure action parametersPUTPOSTDELETEGET
          
"dying-gasp": "string", Action to perform when a dying gasp occurs

          
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

          
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

          
"session-up": "string", Action to perform when a session comes up

          
"link-fault": "string", Action to perform when a link fault message\nis received

          
"critical-event": "string", Action to perform when a critical event\noccurs

          
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

          
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

          
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

          
"session-down": "string" Action to perform when a session goes down

        },
        : {
Configure remote requirement parametersPUTPOSTDELETEGET
          
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

          
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

          
"mode": "string", Possible required OAM modes

          
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

        },
        
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/

Delete operation of resource: profiles

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/

Retrieve operation of resource: profiles

200 OK
a2_profiles_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of Ethernet Link OAM profilesPUTPOSTDELETEGET
    : [
nonePUTPOSTDELETEGET
      {
        : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
          : {
Frame-seconds event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            },
            
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          },
          : {
Symbol-period event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"units": "string", The units to use for this window

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            : {
Size of the frame-period windowPUTPOSTDELETEGET
              
"units": "string", The units to use for this window

              
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

            }
          },
          
"monitoring": "boolean", Enable or disable monitoring
          : {
Frame event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          },
          : {
Frame-period event configurationPUTPOSTDELETEGET
            : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
              
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

              
"units": "string", The units to use for this window

              
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            },
            : {
Size of the frame-period windowPUTPOSTDELETEGET
              
"units": "string", The units to use for this window

              
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

            }
          }
        },
        
"profile": "string", none

        
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

        
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

        
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

        
"mode": "string", Possible required OAM modes

        
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
        : {
Configure action parametersPUTPOSTDELETEGET
          
"dying-gasp": "string", Action to perform when a dying gasp occurs

          
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

          
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

          
"session-up": "string", Action to perform when a session comes up

          
"link-fault": "string", Action to perform when a link fault message\nis received

          
"critical-event": "string", Action to perform when a critical event\noccurs

          
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

          
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

          
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

          
"session-down": "string" Action to perform when a session goes down

        },
        : {
Configure remote requirement parametersPUTPOSTDELETEGET
          
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

          
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

          
"mode": "string", Possible required OAM modes

          
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

        },
        
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

      }
    ]
  }
}

PROFILE - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/

Update operation of resource: profile

a2_profile_schema

profilebody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : [
nonePUTPOSTDELETEGET
    {
      : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
        : {
Frame-seconds event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Symbol-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        },
        
"monitoring": "boolean", Enable or disable monitoring
        : {
Frame event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Frame-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        }
      },
      
"profile": "string", none

      
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

      
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

      
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

      
"mode": "string", Possible required OAM modes

      
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
      : {
Configure action parametersPUTPOSTDELETEGET
        
"dying-gasp": "string", Action to perform when a dying gasp occurs

        
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

        
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

        
"session-up": "string", Action to perform when a session comes up

        
"link-fault": "string", Action to perform when a link fault message\nis received

        
"critical-event": "string", Action to perform when a critical event\noccurs

        
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

        
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

        
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

        
"session-down": "string" Action to perform when a session goes down

      },
      : {
Configure remote requirement parametersPUTPOSTDELETEGET
        
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

        
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

        
"mode": "string", Possible required OAM modes

        
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

      },
      
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/

Create operation of resource: profile

a2_profile_schema

profilebody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : [
nonePUTPOSTDELETEGET
    {
      : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
        : {
Frame-seconds event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Symbol-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        },
        
"monitoring": "boolean", Enable or disable monitoring
        : {
Frame event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Frame-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        }
      },
      
"profile": "string", none

      
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

      
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

      
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

      
"mode": "string", Possible required OAM modes

      
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
      : {
Configure action parametersPUTPOSTDELETEGET
        
"dying-gasp": "string", Action to perform when a dying gasp occurs

        
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

        
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

        
"session-up": "string", Action to perform when a session comes up

        
"link-fault": "string", Action to perform when a link fault message\nis received

        
"critical-event": "string", Action to perform when a critical event\noccurs

        
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

        
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

        
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

        
"session-down": "string" Action to perform when a session goes down

      },
      : {
Configure remote requirement parametersPUTPOSTDELETEGET
        
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

        
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

        
"mode": "string", Possible required OAM modes

        
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

      },
      
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/

Delete operation of resource: profile

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/

Retrieve operation of resource: profile

profile: string
in path

ID of profile

200 OK
a2_profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
nonePUTPOSTDELETEGET
    {
      : {
Enable or disable link monitoring\nrequirementPUTPOSTDELETEGET
        : {
Frame-seconds event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Symbol-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        },
        
"monitoring": "boolean", Enable or disable monitoring
        : {
Frame event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Frame-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        }
      },
      
"profile": "string", none

      
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

      
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement

      
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

      
"mode": "string", Possible required OAM modes

      
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
      : {
Configure action parametersPUTPOSTDELETEGET
        
"dying-gasp": "string", Action to perform when a dying gasp occurs

        
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

        
"remote-loopback": "string", Enable or disable remote loopback\nrequirement

        
"session-up": "string", Action to perform when a session comes up

        
"link-fault": "string", Action to perform when a link fault message\nis received

        
"critical-event": "string", Action to perform when a critical event\noccurs

        
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

        
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

        
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

        
"session-down": "string" Action to perform when a session goes down

      },
      : {
Configure remote requirement parametersPUTPOSTDELETEGET
        
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

        
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

        
"mode": "string", Possible required OAM modes

        
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

      },
      
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support

    }
  ]
}

ACTION - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/action/

Update operation of resource: action

a2_action_schema

actionbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Configure action parametersPUTPOSTDELETEGET
    
"dying-gasp": "string", Action to perform when a dying gasp occurs

    
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

    
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited

    
"session-up": "string", Action to perform when a session comes up

    
"link-fault": "string", Action to perform when a link fault message\nis received

    
"critical-event": "string", Action to perform when a critical event\noccurs

    
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

    
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

    
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

    
"session-down": "string" Action to perform when a session goes down

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/action/

Create operation of resource: action

a2_action_schema

actionbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Configure action parametersPUTPOSTDELETEGET
    
"dying-gasp": "string", Action to perform when a dying gasp occurs

    
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

    
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited

    
"session-up": "string", Action to perform when a session comes up

    
"link-fault": "string", Action to perform when a link fault message\nis received

    
"critical-event": "string", Action to perform when a critical event\noccurs

    
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

    
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

    
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

    
"session-down": "string" Action to perform when a session goes down

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/action/

Delete operation of resource: action

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/action/

Retrieve operation of resource: action

profile: string
in path

ID of profile

200 OK
a2_action_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure action parametersPUTPOSTDELETEGET
    
"dying-gasp": "string", Action to perform when a dying gasp occurs

    
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs

    
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited

    
"session-up": "string", Action to perform when a session comes up

    
"link-fault": "string", Action to perform when a link fault message\nis received

    
"critical-event": "string", Action to perform when a critical event\noccurs

    
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

    
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs

    
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

    
"session-down": "string" Action to perform when a session goes down

  }
}

REQUIRE-REMOTE - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/require-remote/

Update operation of resource: require-remote

a2_require-remote_schema

require-remotebody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Configure remote requirement parametersPUTPOSTDELETEGET
    
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

    
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

    
"mode": "string", Possible required OAM modes

    
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUIRE-REMOTE - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/require-remote/

Create operation of resource: require-remote

a2_require-remote_schema

require-remotebody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Configure remote requirement parametersPUTPOSTDELETEGET
    
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

    
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

    
"mode": "string", Possible required OAM modes

    
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUIRE-REMOTE - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/require-remote/

Delete operation of resource: require-remote

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUIRE-REMOTE - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/require-remote/

Retrieve operation of resource: require-remote

profile: string
in path

ID of profile

200 OK
a2_require-remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure remote requirement parametersPUTPOSTDELETEGET
    
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement

    
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement

    
"mode": "string", Possible required OAM modes

    
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement

  }
}

LINK-MONITORING - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/

Update operation of resource: link-monitoring

a2_link-monitoring_schema

link-monitoringbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Configure link monitor parametersPUTPOSTDELETEGET
    : {
Frame-seconds event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Symbol-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    },
    
"monitoring": "boolean", Enable or disable monitoring
    : {
Frame event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Frame-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-MONITORING - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/

Create operation of resource: link-monitoring

a2_link-monitoring_schema

link-monitoringbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Configure link monitor parametersPUTPOSTDELETEGET
    : {
Frame-seconds event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Symbol-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    },
    
"monitoring": "boolean", Enable or disable monitoring
    : {
Frame event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Frame-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-MONITORING - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/

Delete operation of resource: link-monitoring

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-MONITORING - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/

Retrieve operation of resource: link-monitoring

profile: string
in path

ID of profile

200 OK
a2_link-monitoring_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure link monitor parametersPUTPOSTDELETEGET
    : {
Frame-seconds event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Symbol-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    },
    
"monitoring": "boolean", Enable or disable monitoring
    : {
Frame event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Frame-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    }
  }
}

SYMBOL-PERIOD - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/

Update operation of resource: symbol-period

a2_symbol-period_schema

symbol-periodbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Symbol-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for symbol-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"

      
"units": "string", Units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

    },
    : {
Size of the symbol-period windowPUTPOSTDELETEGET
      
"units": "string", Units to use for this window

      
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYMBOL-PERIOD - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/

Create operation of resource: symbol-period

a2_symbol-period_schema

symbol-periodbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Symbol-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for symbol-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"

      
"units": "string", Units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

    },
    : {
Size of the symbol-period windowPUTPOSTDELETEGET
      
"units": "string", Units to use for this window

      
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYMBOL-PERIOD - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/

Delete operation of resource: symbol-period

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYMBOL-PERIOD - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/

Retrieve operation of resource: symbol-period

profile: string
in path

ID of profile

200 OK
a2_symbol-period_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Symbol-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for symbol-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"

      
"units": "string", Units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

    },
    : {
Size of the symbol-period windowPUTPOSTDELETEGET
      
"units": "string", Units to use for this window

      
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)

    }
  }
}

WINDOW - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/window/

Update operation of resource: window

a2_window_schema

windowbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/window/

Create operation of resource: window

a2_window_schema

windowbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/window/

Delete operation of resource: window

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/window/

Retrieve operation of resource: window

profile: string
in path

ID of profile

200 OK
a2_window_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/threshold/

Update operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/threshold/

Create operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/threshold/

Delete operation of resource: threshold

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/symbol-period/threshold/

Retrieve operation of resource: threshold

profile: string
in path

ID of profile

200 OK
a2_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

FRAME-PERIOD - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/

Update operation of resource: frame-period

a2_frame-period_schema

frame-periodbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Frame-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

      
"units": "string", The units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

    },
    : {
Size of the frame-period windowPUTPOSTDELETEGET
      
"units": "string", The units to use for this window

      
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-PERIOD - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/

Create operation of resource: frame-period

a2_frame-period_schema

frame-periodbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Frame-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

      
"units": "string", The units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

    },
    : {
Size of the frame-period windowPUTPOSTDELETEGET
      
"units": "string", The units to use for this window

      
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-PERIOD - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/

Delete operation of resource: frame-period

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-PERIOD - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/

Retrieve operation of resource: frame-period

profile: string
in path

ID of profile

200 OK
a2_frame-period_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Frame-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

      
"units": "string", The units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

    },
    : {
Size of the frame-period windowPUTPOSTDELETEGET
      
"units": "string", The units to use for this window

      
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

    }
  }
}

WINDOW - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/window/

Update operation of resource: window

a2_window_schema

windowbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/window/

Create operation of resource: window

a2_window_schema

windowbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/window/

Delete operation of resource: window

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/window/

Retrieve operation of resource: window

profile: string
in path

ID of profile

200 OK
a2_window_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/threshold/

Update operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/threshold/

Create operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/threshold/

Delete operation of resource: threshold

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-period/threshold/

Retrieve operation of resource: threshold

profile: string
in path

ID of profile

200 OK
a2_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

FRAME-SECONDS - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/

Update operation of resource: frame-seconds

a2_frame-seconds_schema

frame-secondsbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Frame-seconds event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-seconds\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

      
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

    },
    
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-SECONDS - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/

Create operation of resource: frame-seconds

a2_frame-seconds_schema

frame-secondsbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Frame-seconds event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-seconds\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

      
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

    },
    
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-SECONDS - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/

Delete operation of resource: frame-seconds

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-SECONDS - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/

Retrieve operation of resource: frame-seconds

profile: string
in path

ID of profile

200 OK
a2_frame-seconds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Frame-seconds event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-seconds\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

      
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

    },
    
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/threshold/

Update operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/threshold/

Create operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/threshold/

Delete operation of resource: threshold

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame-seconds/threshold/

Retrieve operation of resource: threshold

profile: string
in path

ID of profile

200 OK
a2_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

FRAME - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/

Update operation of resource: frame

a2_frame_schema

framebody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame-seconds\nevents
    
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

    
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

  },
  
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/

Create operation of resource: frame

a2_frame_schema

framebody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame-seconds\nevents
    
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

    
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

  },
  
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/

Delete operation of resource: frame

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/

Retrieve operation of resource: frame

profile: string
in path

ID of profile

200 OK
a2_frame_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame-seconds\nevents
    
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

    
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

  },
  
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

}

THRESHOLD - Update

PUT Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/threshold/

Update operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/threshold/

Create operation of resource: threshold

a2_threshold_schema

thresholdbody object

profile: string
in path

ID of profile

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/threshold/

Delete operation of resource: threshold

profile: string
in path

ID of profile

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-l2-eth-infra-cfg:ethernet-features/ether-link-oam/profiles/profile/{profile}/link-monitoring/frame/threshold/

Retrieve operation of resource: threshold

profile: string
in path

ID of profile

200 OK
a2_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

GLOBAL-INTERFACE-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Update operation of resource: global-interface-configuration

a3_global-interface-configuration_schema

global-interface-configurationbody object

Request Content-Types: application/json
Request Example
{
  : {
Global scoped configuration for interfacesPUTPOSTDELETEGET
    
"link-status": "string" Enable or disable link-status messages

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Create operation of resource: global-interface-configuration

a3_global-interface-configuration_schema

global-interface-configurationbody object

Request Content-Types: application/json
Request Example
{
  : {
Global scoped configuration for interfacesPUTPOSTDELETEGET
    
"link-status": "string" Enable or disable link-status messages

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Delete operation of resource: global-interface-configuration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Retrieve operation of resource: global-interface-configuration

200 OK
a3_global-interface-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Global scoped configuration for interfacesPUTPOSTDELETEGET
    
"link-status": "string" Enable or disable link-status messages

  }
}

INTERFACE-CONFIGURATIONS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Update operation of resource: interface-configurations

a3_interface-configurations_schema

interface-configurationsbody object

Request Content-Types: application/json
Request Example
{
  : {
interface configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.

        
"description": "string", The description of this interface

        
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface.
        : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
          
"ingress": "null", Per MAC address accounting statistics

          
"egress": "null" Per MAC address accounting statistics

        },
        
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s"
        : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
          
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
          : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
            : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
              : {
Frame-seconds event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Symbol-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              },
              
"monitoring": "boolean", Enable or disable monitoring
              : {
Frame event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Frame-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              }
            },
            
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

            
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

            
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

            
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

            
"mode": "string", How to handle the protocol's packets

            
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
            : {
Configure action parametersPUTPOSTDELETEGET
              
"dying-gasp": "string", Action to perform when a dying gasp occurs

              
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

              
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

              
"session-up": "string", Action to perform when a session comes up

              
"critical-event": "string", Action to perform when a critical event occurs

              
"link-fault": "string", Action to perform when a link fault occurs

              
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

              
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

              
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

              
"session-down": "string" Action to perform when a session comes down

            },
            : {
Configure remote requirement parametersPUTPOSTDELETEGET
              
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

              
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

              
"mode": "string", How to handle the protocol's packets

              
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

            },
            
"profile-name": "string" Set the profile to use on the interface

          },
          
"filtering": "string" Ingress Ethernet frame filtering

        },
        
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down
        : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
          : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
            
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

            
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.

          },
          
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

        },
        
"active": "string", Whether the interface is active or\npreconfigured
        : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
          
"encapsulation": "string", The encapsulation of this Ethernet service

          
"capsulation-options": "integer" The options for this capsulation, usually '0'

        },
        : {
BVI attributesPUTPOSTDELETEGET
          
"host-routing": "null" Enable host-routing on this BVI

        },
        : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
          
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

          
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

        },
        : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
          : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
            
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

            
"first-tag": "string", First (outermost) VLAN tag value

            
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

          }
        },
        : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
          
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
          : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

                
"l2-protocol-name": "string", Protocol name

                
"mode": "string" How to handle the protocol's packets

              }
            ]
          },
          
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
          : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
            
"egress-filtering": "string", Egress Ethernet filtering

            
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

          }
        },
        : {
PW-IW attributesPUTPOSTDELETEGET
          
"generic-interface-list": "string", Name of the interface list

          
"l2-overhead": "integer" PW Ether L2 overhead requirement

        },
        : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
          
"args": "string", Dampening Arguments

          
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

          
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

          
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

          
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

          
"restart-penalty": "integer" Restart penalty
range: "0..20000"

        },
        
"interface-name": "string", The name of the interface

        
"secondary-admin-state": "string", The secondary admin state of the interface
        : {
Ethernet service configurationPUTPOSTDELETEGET
          : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"outer-vlan-id": "string", VLAN id for outer tag

            
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

          },
          : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
            
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

            
"rewrite-type": "string", The type of rewrite to perform

            
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          },
          : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
            
"ingress-destination-mac": "string", Destination MAC address to match on egress

            
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

            
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

            
"inner-range1-high": "string", High value of first range for inner tag match

            
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

            
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

            
"outer-range1-low": "string", Low value of first range for outer tag match

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

            
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

            
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

            
"payload-ethertype-match": "string", Which payload ethertype values to match

            
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

            
"inner-range1-low": "string", Low value of first range for inner tag match

            
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

            
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

            
"additional-range3-high": "string", High value of third additional range for tag\nmatch

            
"ingress-source-mac": "string", Source MAC address to match on ingress

            
"outer-range1-high": "string", High value of first range for outer tag match

            
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

            
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

            
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

            
"additional-range2-high": "string", High value of second additional range for tag\nmatch

            
"exact": "null", Only match packets with no more tags than\nexplicitly matched

            
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

            
"additional-range1-high": "string" High value of first additional range for tag\nmatch

          }
        },
        : {
PW-Ether attributesPUTPOSTDELETEGET
          
"l2-overhead": "integer", PW Ether L2 overhead requirement

          
"generic-interface-list": "string" Name of the interface list

        },
        
"link-status": "null", Enable interface and line-protocol state change\nalarms
        : {
The MTU configuration for the interfacePUTPOSTDELETEGET
          : [
The MTU valuePUTPOSTDELETEGET
            {
              
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

              
"mtu": "integer" The MTU value
range: "64..65535"

            }
          ]
        },
        : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
          : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
            
"ingress-destination-mac": "string", Destination MAC address to match on egress

            
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

            
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

            
"inner-range1-high": "string", High value of first range for inner tag match

            
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

            
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

            
"outer-range1-low": "string", Low value of first range for outer tag match

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

            
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

            
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

            
"payload-ethertype-match": "string", Which payload ethertype values to match

            
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

            
"inner-range1-low": "string", Low value of first range for inner tag match

            
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

            
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

            
"additional-range3-high": "string", High value of third additional range for tag\nmatch

            
"ingress-source-mac": "string", Source MAC address to match on ingress

            
"outer-range1-high": "string", High value of first range for outer tag match

            
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

            
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

            
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

            
"additional-range2-high": "string", High value of second additional range for tag\nmatch

            
"exact": "null", Only match packets with no more tags than\nexplicitly matched

            
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

            
"additional-range1-high": "string" High value of first additional range for tag\nmatch

          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Create operation of resource: interface-configurations

a3_interface-configurations_schema

interface-configurationsbody object

Request Content-Types: application/json
Request Example
{
  : {
interface configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.

        
"description": "string", The description of this interface

        
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface.
        : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
          
"ingress": "null", Per MAC address accounting statistics

          
"egress": "null" Per MAC address accounting statistics

        },
        
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s"
        : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
          
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
          : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
            : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
              : {
Frame-seconds event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Symbol-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              },
              
"monitoring": "boolean", Enable or disable monitoring
              : {
Frame event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Frame-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              }
            },
            
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

            
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

            
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

            
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

            
"mode": "string", How to handle the protocol's packets

            
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
            : {
Configure action parametersPUTPOSTDELETEGET
              
"dying-gasp": "string", Action to perform when a dying gasp occurs

              
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

              
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

              
"session-up": "string", Action to perform when a session comes up

              
"critical-event": "string", Action to perform when a critical event occurs

              
"link-fault": "string", Action to perform when a link fault occurs

              
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

              
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

              
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

              
"session-down": "string" Action to perform when a session comes down

            },
            : {
Configure remote requirement parametersPUTPOSTDELETEGET
              
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

              
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

              
"mode": "string", How to handle the protocol's packets

              
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

            },
            
"profile-name": "string" Set the profile to use on the interface

          },
          
"filtering": "string" Ingress Ethernet frame filtering

        },
        
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down
        : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
          : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
            
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

            
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.

          },
          
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

        },
        
"active": "string", Whether the interface is active or\npreconfigured
        : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
          
"encapsulation": "string", The encapsulation of this Ethernet service

          
"capsulation-options": "integer" The options for this capsulation, usually '0'

        },
        : {
BVI attributesPUTPOSTDELETEGET
          
"host-routing": "null" Enable host-routing on this BVI

        },
        : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
          
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

          
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

        },
        : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
          : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
            
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

            
"first-tag": "string", First (outermost) VLAN tag value

            
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

          }
        },
        : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
          
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
          : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

                
"l2-protocol-name": "string", Protocol name

                
"mode": "string" How to handle the protocol's packets

              }
            ]
          },
          
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
          : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
            
"egress-filtering": "string", Egress Ethernet filtering

            
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

          }
        },
        : {
PW-IW attributesPUTPOSTDELETEGET
          
"generic-interface-list": "string", Name of the interface list

          
"l2-overhead": "integer" PW Ether L2 overhead requirement

        },
        : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
          
"args": "string", Dampening Arguments

          
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

          
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

          
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

          
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

          
"restart-penalty": "integer" Restart penalty
range: "0..20000"

        },
        
"interface-name": "string", The name of the interface

        
"secondary-admin-state": "string", The secondary admin state of the interface
        : {
Ethernet service configurationPUTPOSTDELETEGET
          : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"outer-vlan-id": "string", VLAN id for outer tag

            
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

          },
          : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
            
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

            
"rewrite-type": "string", The type of rewrite to perform

            
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          },
          : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
            
"ingress-destination-mac": "string", Destination MAC address to match on egress

            
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

            
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

            
"inner-range1-high": "string", High value of first range for inner tag match

            
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

            
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

            
"outer-range1-low": "string", Low value of first range for outer tag match

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

            
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

            
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

            
"payload-ethertype-match": "string", Which payload ethertype values to match

            
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

            
"inner-range1-low": "string", Low value of first range for inner tag match

            
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

            
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

            
"additional-range3-high": "string", High value of third additional range for tag\nmatch

            
"ingress-source-mac": "string", Source MAC address to match on ingress

            
"outer-range1-high": "string", High value of first range for outer tag match

            
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

            
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

            
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

            
"additional-range2-high": "string", High value of second additional range for tag\nmatch

            
"exact": "null", Only match packets with no more tags than\nexplicitly matched

            
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

            
"additional-range1-high": "string" High value of first additional range for tag\nmatch

          }
        },
        : {
PW-Ether attributesPUTPOSTDELETEGET
          
"l2-overhead": "integer", PW Ether L2 overhead requirement

          
"generic-interface-list": "string" Name of the interface list

        },
        
"link-status": "null", Enable interface and line-protocol state change\nalarms
        : {
The MTU configuration for the interfacePUTPOSTDELETEGET
          : [
The MTU valuePUTPOSTDELETEGET
            {
              
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

              
"mtu": "integer" The MTU value
range: "64..65535"

            }
          ]
        },
        : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
          : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
            
"ingress-destination-mac": "string", Destination MAC address to match on egress

            
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

            
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

            
"inner-range1-high": "string", High value of first range for inner tag match

            
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

            
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

            
"outer-range1-low": "string", Low value of first range for outer tag match

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

            
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

            
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

            
"payload-ethertype-match": "string", Which payload ethertype values to match

            
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

            
"inner-range1-low": "string", Low value of first range for inner tag match

            
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

            
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

            
"additional-range3-high": "string", High value of third additional range for tag\nmatch

            
"ingress-source-mac": "string", Source MAC address to match on ingress

            
"outer-range1-high": "string", High value of first range for outer tag match

            
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

            
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

            
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

            
"additional-range2-high": "string", High value of second additional range for tag\nmatch

            
"exact": "null", Only match packets with no more tags than\nexplicitly matched

            
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

            
"additional-range1-high": "string" High value of first additional range for tag\nmatch

          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Delete operation of resource: interface-configurations

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Retrieve operation of resource: interface-configurations

200 OK
a3_interface-configurations_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
interface configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.

        
"description": "string", The description of this interface

        
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface.
        : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
          
"ingress": "null", Per MAC address accounting statistics

          
"egress": "null" Per MAC address accounting statistics

        },
        
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s"
        : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
          
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
          : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
            : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
              : {
Frame-seconds event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Symbol-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              },
              
"monitoring": "boolean", Enable or disable monitoring
              : {
Frame event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

              },
              : {
Frame-period event configurationPUTPOSTDELETEGET
                : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                  
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                  
"units": "string", The units to use for this window

                  
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                  
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                  
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                },
                : {
Size of the frame-period windowPUTPOSTDELETEGET
                  
"units": "string", The units to use for this window

                  
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                  
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

                }
              }
            },
            
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

            
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

            
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

            
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

            
"mode": "string", How to handle the protocol's packets

            
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
            : {
Configure action parametersPUTPOSTDELETEGET
              
"dying-gasp": "string", Action to perform when a dying gasp occurs

              
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

              
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

              
"session-up": "string", Action to perform when a session comes up

              
"critical-event": "string", Action to perform when a critical event occurs

              
"link-fault": "string", Action to perform when a link fault occurs

              
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

              
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

              
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

              
"session-down": "string" Action to perform when a session comes down

            },
            : {
Configure remote requirement parametersPUTPOSTDELETEGET
              
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

              
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

              
"mode": "string", How to handle the protocol's packets

              
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

            },
            
"profile-name": "string" Set the profile to use on the interface

          },
          
"filtering": "string" Ingress Ethernet frame filtering

        },
        
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down
        : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
          : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
            
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

            
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.

          },
          
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

        },
        
"active": "string", Whether the interface is active or\npreconfigured
        : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
          
"encapsulation": "string", The encapsulation of this Ethernet service

          
"capsulation-options": "integer" The options for this capsulation, usually '0'

        },
        : {
BVI attributesPUTPOSTDELETEGET
          
"host-routing": "null" Enable host-routing on this BVI

        },
        : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
          
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

          
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

        },
        : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
          : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
            
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

            
"first-tag": "string", First (outermost) VLAN tag value

            
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

          }
        },
        : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
          
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
          : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

                
"l2-protocol-name": "string", Protocol name

                
"mode": "string" How to handle the protocol's packets

              }
            ]
          },
          
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
          : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
            
"egress-filtering": "string", Egress Ethernet filtering

            
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

          }
        },
        : {
PW-IW attributesPUTPOSTDELETEGET
          
"generic-interface-list": "string", Name of the interface list

          
"l2-overhead": "integer" PW Ether L2 overhead requirement

        },
        : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
          
"args": "string", Dampening Arguments

          
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

          
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

          
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

          
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

          
"restart-penalty": "integer" Restart penalty
range: "0..20000"

        },
        
"interface-name": "string", The name of the interface

        
"secondary-admin-state": "string", The secondary admin state of the interface
        : {
Ethernet service configurationPUTPOSTDELETEGET
          : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"outer-vlan-id": "string", VLAN id for outer tag

            
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

          },
          : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
            
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

            
"rewrite-type": "string", The type of rewrite to perform

            
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          },
          : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
            
"ingress-destination-mac": "string", Destination MAC address to match on egress

            
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

            
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

            
"inner-range1-high": "string", High value of first range for inner tag match

            
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

            
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

            
"outer-range1-low": "string", Low value of first range for outer tag match

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

            
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

            
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

            
"payload-ethertype-match": "string", Which payload ethertype values to match

            
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

            
"inner-range1-low": "string", Low value of first range for inner tag match

            
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

            
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

            
"additional-range3-high": "string", High value of third additional range for tag\nmatch

            
"ingress-source-mac": "string", Source MAC address to match on ingress

            
"outer-range1-high": "string", High value of first range for outer tag match

            
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

            
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

            
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

            
"additional-range2-high": "string", High value of second additional range for tag\nmatch

            
"exact": "null", Only match packets with no more tags than\nexplicitly matched

            
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

            
"additional-range1-high": "string" High value of first additional range for tag\nmatch

          }
        },
        : {
PW-Ether attributesPUTPOSTDELETEGET
          
"l2-overhead": "integer", PW Ether L2 overhead requirement

          
"generic-interface-list": "string" Name of the interface list

        },
        
"link-status": "null", Enable interface and line-protocol state change\nalarms
        : {
The MTU configuration for the interfacePUTPOSTDELETEGET
          : [
The MTU valuePUTPOSTDELETEGET
            {
              
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

              
"mtu": "integer" The MTU value
range: "64..65535"

            }
          ]
        },
        : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
          : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
            
"ingress-destination-mac": "string", Destination MAC address to match on egress

            
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

            
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

            
"inner-range1-high": "string", High value of first range for inner tag match

            
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

            
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

            
"outer-range1-low": "string", Low value of first range for outer tag match

            
"inner-tag-type": "string", Type of tag for inner match (if present)

            
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

            
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

            
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

            
"payload-ethertype-match": "string", Which payload ethertype values to match

            
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

            
"inner-range1-low": "string", Low value of first range for inner tag match

            
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

            
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

            
"additional-range3-high": "string", High value of third additional range for tag\nmatch

            
"ingress-source-mac": "string", Source MAC address to match on ingress

            
"outer-range1-high": "string", High value of first range for outer tag match

            
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

            
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

            
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

            
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

            
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

            
"additional-range2-high": "string", High value of second additional range for tag\nmatch

            
"exact": "null", Only match packets with no more tags than\nexplicitly matched

            
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

            
"additional-range1-high": "string" High value of first additional range for tag\nmatch

          }
        }
      }
    ]
  }
}

INTERFACE-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Update operation of resource: interface-configuration

a3_interface-configuration_schema

interface-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.

      
"description": "string", The description of this interface

      
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface.
      : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
        
"ingress": "null", Per MAC address accounting statistics

        
"egress": "null" Per MAC address accounting statistics

      },
      
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s"
      : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
        
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
        : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
          : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
            : {
Frame-seconds event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Symbol-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            },
            
"monitoring": "boolean", Enable or disable monitoring
            : {
Frame event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Frame-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            }
          },
          
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

          
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

          
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

          
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

          
"mode": "string", How to handle the protocol's packets

          
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
          : {
Configure action parametersPUTPOSTDELETEGET
            
"dying-gasp": "string", Action to perform when a dying gasp occurs

            
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

            
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

            
"session-up": "string", Action to perform when a session comes up

            
"critical-event": "string", Action to perform when a critical event occurs

            
"link-fault": "string", Action to perform when a link fault occurs

            
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

            
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

            
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

            
"session-down": "string" Action to perform when a session comes down

          },
          : {
Configure remote requirement parametersPUTPOSTDELETEGET
            
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

            
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

            
"mode": "string", How to handle the protocol's packets

            
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

          },
          
"profile-name": "string" Set the profile to use on the interface

        },
        
"filtering": "string" Ingress Ethernet frame filtering

      },
      
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down
      : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
        : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
          
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

          
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.

        },
        
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

      },
      
"active": "string", Whether the interface is active or\npreconfigured
      : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
        
"encapsulation": "string", The encapsulation of this Ethernet service

        
"capsulation-options": "integer" The options for this capsulation, usually '0'

      },
      : {
BVI attributesPUTPOSTDELETEGET
        
"host-routing": "null" Enable host-routing on this BVI

      },
      : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
        
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

        
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

      },
      : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
        : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
          
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

          
"first-tag": "string", First (outermost) VLAN tag value

          
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

        }
      },
      : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
        
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
        : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

              
"l2-protocol-name": "string", Protocol name

              
"mode": "string" How to handle the protocol's packets

            }
          ]
        },
        
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
        : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
          
"egress-filtering": "string", Egress Ethernet filtering

          
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

        }
      },
      : {
PW-IW attributesPUTPOSTDELETEGET
        
"generic-interface-list": "string", Name of the interface list

        
"l2-overhead": "integer" PW Ether L2 overhead requirement

      },
      : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
        
"args": "string", Dampening Arguments

        
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

        
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

        
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

        
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

        
"restart-penalty": "integer" Restart penalty
range: "0..20000"

      },
      
"interface-name": "string", The name of the interface

      
"secondary-admin-state": "string", The secondary admin state of the interface
      : {
Ethernet service configurationPUTPOSTDELETEGET
        : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"outer-vlan-id": "string", VLAN id for outer tag

          
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

        },
        : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
          
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

          
"rewrite-type": "string", The type of rewrite to perform

          
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

        },
        : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
          
"ingress-destination-mac": "string", Destination MAC address to match on egress

          
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

          
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

          
"inner-range1-high": "string", High value of first range for inner tag match

          
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

          
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

          
"outer-range1-low": "string", Low value of first range for outer tag match

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

          
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

          
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

          
"payload-ethertype-match": "string", Which payload ethertype values to match

          
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

          
"inner-range1-low": "string", Low value of first range for inner tag match

          
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

          
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

          
"additional-range3-high": "string", High value of third additional range for tag\nmatch

          
"ingress-source-mac": "string", Source MAC address to match on ingress

          
"outer-range1-high": "string", High value of first range for outer tag match

          
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

          
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

          
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

          
"additional-range2-high": "string", High value of second additional range for tag\nmatch

          
"exact": "null", Only match packets with no more tags than\nexplicitly matched

          
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

          
"additional-range1-high": "string" High value of first additional range for tag\nmatch

        }
      },
      : {
PW-Ether attributesPUTPOSTDELETEGET
        
"l2-overhead": "integer", PW Ether L2 overhead requirement

        
"generic-interface-list": "string" Name of the interface list

      },
      
"link-status": "null", Enable interface and line-protocol state change\nalarms
      : {
The MTU configuration for the interfacePUTPOSTDELETEGET
        : [
The MTU valuePUTPOSTDELETEGET
          {
            
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

            
"mtu": "integer" The MTU value
range: "64..65535"

          }
        ]
      },
      : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
        : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
          
"ingress-destination-mac": "string", Destination MAC address to match on egress

          
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

          
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

          
"inner-range1-high": "string", High value of first range for inner tag match

          
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

          
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

          
"outer-range1-low": "string", Low value of first range for outer tag match

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

          
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

          
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

          
"payload-ethertype-match": "string", Which payload ethertype values to match

          
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

          
"inner-range1-low": "string", Low value of first range for inner tag match

          
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

          
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

          
"additional-range3-high": "string", High value of third additional range for tag\nmatch

          
"ingress-source-mac": "string", Source MAC address to match on ingress

          
"outer-range1-high": "string", High value of first range for outer tag match

          
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

          
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

          
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

          
"additional-range2-high": "string", High value of second additional range for tag\nmatch

          
"exact": "null", Only match packets with no more tags than\nexplicitly matched

          
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

          
"additional-range1-high": "string" High value of first additional range for tag\nmatch

        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Create operation of resource: interface-configuration

a3_interface-configuration_schema

interface-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.

      
"description": "string", The description of this interface

      
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface.
      : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
        
"ingress": "null", Per MAC address accounting statistics

        
"egress": "null" Per MAC address accounting statistics

      },
      
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s"
      : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
        
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
        : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
          : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
            : {
Frame-seconds event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Symbol-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            },
            
"monitoring": "boolean", Enable or disable monitoring
            : {
Frame event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Frame-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            }
          },
          
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

          
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

          
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

          
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

          
"mode": "string", How to handle the protocol's packets

          
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
          : {
Configure action parametersPUTPOSTDELETEGET
            
"dying-gasp": "string", Action to perform when a dying gasp occurs

            
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

            
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

            
"session-up": "string", Action to perform when a session comes up

            
"critical-event": "string", Action to perform when a critical event occurs

            
"link-fault": "string", Action to perform when a link fault occurs

            
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

            
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

            
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

            
"session-down": "string" Action to perform when a session comes down

          },
          : {
Configure remote requirement parametersPUTPOSTDELETEGET
            
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

            
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

            
"mode": "string", How to handle the protocol's packets

            
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

          },
          
"profile-name": "string" Set the profile to use on the interface

        },
        
"filtering": "string" Ingress Ethernet frame filtering

      },
      
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down
      : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
        : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
          
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

          
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.

        },
        
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

      },
      
"active": "string", Whether the interface is active or\npreconfigured
      : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
        
"encapsulation": "string", The encapsulation of this Ethernet service

        
"capsulation-options": "integer" The options for this capsulation, usually '0'

      },
      : {
BVI attributesPUTPOSTDELETEGET
        
"host-routing": "null" Enable host-routing on this BVI

      },
      : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
        
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

        
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

      },
      : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
        : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
          
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

          
"first-tag": "string", First (outermost) VLAN tag value

          
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

        }
      },
      : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
        
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
        : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

              
"l2-protocol-name": "string", Protocol name

              
"mode": "string" How to handle the protocol's packets

            }
          ]
        },
        
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
        : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
          
"egress-filtering": "string", Egress Ethernet filtering

          
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

        }
      },
      : {
PW-IW attributesPUTPOSTDELETEGET
        
"generic-interface-list": "string", Name of the interface list

        
"l2-overhead": "integer" PW Ether L2 overhead requirement

      },
      : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
        
"args": "string", Dampening Arguments

        
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

        
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

        
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

        
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

        
"restart-penalty": "integer" Restart penalty
range: "0..20000"

      },
      
"interface-name": "string", The name of the interface

      
"secondary-admin-state": "string", The secondary admin state of the interface
      : {
Ethernet service configurationPUTPOSTDELETEGET
        : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"outer-vlan-id": "string", VLAN id for outer tag

          
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

        },
        : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
          
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

          
"rewrite-type": "string", The type of rewrite to perform

          
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

        },
        : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
          
"ingress-destination-mac": "string", Destination MAC address to match on egress

          
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

          
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

          
"inner-range1-high": "string", High value of first range for inner tag match

          
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

          
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

          
"outer-range1-low": "string", Low value of first range for outer tag match

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

          
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

          
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

          
"payload-ethertype-match": "string", Which payload ethertype values to match

          
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

          
"inner-range1-low": "string", Low value of first range for inner tag match

          
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

          
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

          
"additional-range3-high": "string", High value of third additional range for tag\nmatch

          
"ingress-source-mac": "string", Source MAC address to match on ingress

          
"outer-range1-high": "string", High value of first range for outer tag match

          
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

          
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

          
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

          
"additional-range2-high": "string", High value of second additional range for tag\nmatch

          
"exact": "null", Only match packets with no more tags than\nexplicitly matched

          
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

          
"additional-range1-high": "string" High value of first additional range for tag\nmatch

        }
      },
      : {
PW-Ether attributesPUTPOSTDELETEGET
        
"l2-overhead": "integer", PW Ether L2 overhead requirement

        
"generic-interface-list": "string" Name of the interface list

      },
      
"link-status": "null", Enable interface and line-protocol state change\nalarms
      : {
The MTU configuration for the interfacePUTPOSTDELETEGET
        : [
The MTU valuePUTPOSTDELETEGET
          {
            
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

            
"mtu": "integer" The MTU value
range: "64..65535"

          }
        ]
      },
      : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
        : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
          
"ingress-destination-mac": "string", Destination MAC address to match on egress

          
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

          
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

          
"inner-range1-high": "string", High value of first range for inner tag match

          
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

          
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

          
"outer-range1-low": "string", Low value of first range for outer tag match

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

          
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

          
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

          
"payload-ethertype-match": "string", Which payload ethertype values to match

          
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

          
"inner-range1-low": "string", Low value of first range for inner tag match

          
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

          
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

          
"additional-range3-high": "string", High value of third additional range for tag\nmatch

          
"ingress-source-mac": "string", Source MAC address to match on ingress

          
"outer-range1-high": "string", High value of first range for outer tag match

          
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

          
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

          
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

          
"additional-range2-high": "string", High value of second additional range for tag\nmatch

          
"exact": "null", Only match packets with no more tags than\nexplicitly matched

          
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

          
"additional-range1-high": "string" High value of first additional range for tag\nmatch

        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Delete operation of resource: interface-configuration

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Retrieve operation of resource: interface-configuration

active interface-name: string
in path

ID of active interface-name

200 OK
a3_interface-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.

      
"description": "string", The description of this interface

      
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface.
      : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
        
"ingress": "null", Per MAC address accounting statistics

        
"egress": "null" Per MAC address accounting statistics

      },
      
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s"
      : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
        
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
        : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
          : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
            : {
Frame-seconds event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Symbol-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            },
            
"monitoring": "boolean", Enable or disable monitoring
            : {
Frame event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            },
            : {
Frame-period event configurationPUTPOSTDELETEGET
              : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
                
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

                
"units": "string", The units to use for this window

                
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

                
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

                
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

              },
              : {
Size of the frame-period windowPUTPOSTDELETEGET
                
"units": "string", The units to use for this window

                
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

                
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

              }
            }
          },
          
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

          
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

          
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

          
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

          
"mode": "string", How to handle the protocol's packets

          
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
          : {
Configure action parametersPUTPOSTDELETEGET
            
"dying-gasp": "string", Action to perform when a dying gasp occurs

            
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

            
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

            
"session-up": "string", Action to perform when a session comes up

            
"critical-event": "string", Action to perform when a critical event occurs

            
"link-fault": "string", Action to perform when a link fault occurs

            
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

            
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

            
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

            
"session-down": "string" Action to perform when a session comes down

          },
          : {
Configure remote requirement parametersPUTPOSTDELETEGET
            
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

            
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

            
"mode": "string", How to handle the protocol's packets

            
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

          },
          
"profile-name": "string" Set the profile to use on the interface

        },
        
"filtering": "string" Ingress Ethernet frame filtering

      },
      
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down
      : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
        : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
          
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

          
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.

        },
        
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

      },
      
"active": "string", Whether the interface is active or\npreconfigured
      : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
        
"encapsulation": "string", The encapsulation of this Ethernet service

        
"capsulation-options": "integer" The options for this capsulation, usually '0'

      },
      : {
BVI attributesPUTPOSTDELETEGET
        
"host-routing": "null" Enable host-routing on this BVI

      },
      : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
        
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

        
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

      },
      : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
        : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
          
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

          
"first-tag": "string", First (outermost) VLAN tag value

          
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

        }
      },
      : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
        
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
        : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

              
"l2-protocol-name": "string", Protocol name

              
"mode": "string" How to handle the protocol's packets

            }
          ]
        },
        
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
        : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
          
"egress-filtering": "string", Egress Ethernet filtering

          
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

        }
      },
      : {
PW-IW attributesPUTPOSTDELETEGET
        
"generic-interface-list": "string", Name of the interface list

        
"l2-overhead": "integer" PW Ether L2 overhead requirement

      },
      : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
        
"args": "string", Dampening Arguments

        
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

        
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

        
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

        
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

        
"restart-penalty": "integer" Restart penalty
range: "0..20000"

      },
      
"interface-name": "string", The name of the interface

      
"secondary-admin-state": "string", The secondary admin state of the interface
      : {
Ethernet service configurationPUTPOSTDELETEGET
        : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"outer-vlan-id": "string", VLAN id for outer tag

          
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

        },
        : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
          
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

          
"rewrite-type": "string", The type of rewrite to perform

          
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

        },
        : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
          
"ingress-destination-mac": "string", Destination MAC address to match on egress

          
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

          
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

          
"inner-range1-high": "string", High value of first range for inner tag match

          
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

          
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

          
"outer-range1-low": "string", Low value of first range for outer tag match

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

          
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

          
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

          
"payload-ethertype-match": "string", Which payload ethertype values to match

          
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

          
"inner-range1-low": "string", Low value of first range for inner tag match

          
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

          
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

          
"additional-range3-high": "string", High value of third additional range for tag\nmatch

          
"ingress-source-mac": "string", Source MAC address to match on ingress

          
"outer-range1-high": "string", High value of first range for outer tag match

          
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

          
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

          
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

          
"additional-range2-high": "string", High value of second additional range for tag\nmatch

          
"exact": "null", Only match packets with no more tags than\nexplicitly matched

          
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

          
"additional-range1-high": "string" High value of first additional range for tag\nmatch

        }
      },
      : {
PW-Ether attributesPUTPOSTDELETEGET
        
"l2-overhead": "integer", PW Ether L2 overhead requirement

        
"generic-interface-list": "string" Name of the interface list

      },
      
"link-status": "null", Enable interface and line-protocol state change\nalarms
      : {
The MTU configuration for the interfacePUTPOSTDELETEGET
        : [
The MTU valuePUTPOSTDELETEGET
          {
            
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

            
"mtu": "integer" The MTU value
range: "64..65535"

          }
        ]
      },
      : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
        : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
          
"ingress-destination-mac": "string", Destination MAC address to match on egress

          
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

          
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

          
"inner-range1-high": "string", High value of first range for inner tag match

          
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

          
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

          
"outer-range1-low": "string", Low value of first range for outer tag match

          
"inner-tag-type": "string", Type of tag for inner match (if present)

          
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

          
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

          
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

          
"payload-ethertype-match": "string", Which payload ethertype values to match

          
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

          
"inner-range1-low": "string", Low value of first range for inner tag match

          
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

          
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

          
"additional-range3-high": "string", High value of third additional range for tag\nmatch

          
"ingress-source-mac": "string", Source MAC address to match on ingress

          
"outer-range1-high": "string", High value of first range for outer tag match

          
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

          
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

          
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

          
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

          
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

          
"additional-range2-high": "string", High value of second additional range for tag\nmatch

          
"exact": "null", Only match packets with no more tags than\nexplicitly matched

          
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

          
"additional-range1-high": "string" High value of first additional range for tag\nmatch

        }
      }
    }
  ]
}

DAMPENING - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Update operation of resource: dampening

a3_dampening_schema

dampeningbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
    
"args": "string", Dampening Arguments

    
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

    
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

    
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

    
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

    
"restart-penalty": "integer" Restart penalty
range: "0..20000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Create operation of resource: dampening

a3_dampening_schema

dampeningbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
    
"args": "string", Dampening Arguments

    
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

    
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

    
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

    
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

    
"restart-penalty": "integer" Restart penalty
range: "0..20000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Delete operation of resource: dampening

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Retrieve operation of resource: dampening

active interface-name: string
in path

ID of active interface-name

200 OK
a3_dampening_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Whether this interface's state changes are\ndampened or notPUTPOSTDELETEGET
    
"args": "string", Dampening Arguments

    
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"

    
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"

    
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"

    
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"

    
"restart-penalty": "integer" Restart penalty
range: "0..20000"

  }
}

MTUS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Update operation of resource: mtus

a3_mtus_schema

mtusbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The MTU configuration for the interfacePUTPOSTDELETEGET
    : [
The MTU valuePUTPOSTDELETEGET
      {
        
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

        
"mtu": "integer" The MTU value
range: "64..65535"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Create operation of resource: mtus

a3_mtus_schema

mtusbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The MTU configuration for the interfacePUTPOSTDELETEGET
    : [
The MTU valuePUTPOSTDELETEGET
      {
        
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

        
"mtu": "integer" The MTU value
range: "64..65535"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Delete operation of resource: mtus

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Retrieve operation of resource: mtus

active interface-name: string
in path

ID of active interface-name

200 OK
a3_mtus_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The MTU configuration for the interfacePUTPOSTDELETEGET
    : [
The MTU valuePUTPOSTDELETEGET
      {
        
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

        
"mtu": "integer" The MTU value
range: "64..65535"

      }
    ]
  }
}

MTU - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Update operation of resource: mtu

a3_mtu_schema

mtubody object

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

Request Content-Types: application/json
Request Example
{
  : [
The MTU valuePUTPOSTDELETEGET
    {
      
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

      
"mtu": "integer" The MTU value
range: "64..65535"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Create operation of resource: mtu

a3_mtu_schema

mtubody object

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

Request Content-Types: application/json
Request Example
{
  : [
The MTU valuePUTPOSTDELETEGET
    {
      
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

      
"mtu": "integer" The MTU value
range: "64..65535"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Delete operation of resource: mtu

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Retrieve operation of resource: mtu

active interface-name: string
in path

ID of active interface-name

owner: string
in path

ID of owner

200 OK
a3_mtu_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
The MTU valuePUTPOSTDELETEGET
    {
      
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'

      
"mtu": "integer" The MTU value
range: "64..65535"

    }
  ]
}

ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Update operation of resource: encapsulation

a3_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Create operation of resource: encapsulation

a3_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Delete operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Retrieve operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a3_encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}

PSEUDOWIRE-ETHER - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Update operation of resource: pseudowire-ether

a3_pseudowire-ether_schema

pseudowire-etherbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
PW-Ether attributesPUTPOSTDELETEGET
    
"l2-overhead": "integer", PW Ether L2 overhead requirement

    
"generic-interface-list": "string" Name of the interface list

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-ETHER - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Create operation of resource: pseudowire-ether

a3_pseudowire-ether_schema

pseudowire-etherbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
PW-Ether attributesPUTPOSTDELETEGET
    
"l2-overhead": "integer", PW Ether L2 overhead requirement

    
"generic-interface-list": "string" Name of the interface list

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-ETHER - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Delete operation of resource: pseudowire-ether

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-ETHER - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-ether/

Retrieve operation of resource: pseudowire-ether

active interface-name: string
in path

ID of active interface-name

200 OK
a3_pseudowire-ether_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PW-Ether attributesPUTPOSTDELETEGET
    
"l2-overhead": "integer", PW Ether L2 overhead requirement

    
"generic-interface-list": "string" Name of the interface list

  }
}

PSEUDOWIRE-IW - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Update operation of resource: pseudowire-iw

a3_pseudowire-iw_schema

pseudowire-iwbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
PW-IW attributesPUTPOSTDELETEGET
    
"generic-interface-list": "string", Name of the interface list

    
"l2-overhead": "integer" L2 overhead size in bytes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-IW - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Create operation of resource: pseudowire-iw

a3_pseudowire-iw_schema

pseudowire-iwbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
PW-IW attributesPUTPOSTDELETEGET
    
"generic-interface-list": "string", Name of the interface list

    
"l2-overhead": "integer" L2 overhead size in bytes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-IW - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Delete operation of resource: pseudowire-iw

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE-IW - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/pseudowire-iw/

Retrieve operation of resource: pseudowire-iw

active interface-name: string
in path

ID of active interface-name

200 OK
a3_pseudowire-iw_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PW-IW attributesPUTPOSTDELETEGET
    
"generic-interface-list": "string", Name of the interface list

    
"l2-overhead": "integer" L2 overhead size in bytes

  }
}

BVI - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Update operation of resource: bvi

a3_bvi_schema

bvibody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
BVI attributesPUTPOSTDELETEGET
    
"host-routing": "null" Enable host-routing on this BVI

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BVI - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Create operation of resource: bvi

a3_bvi_schema

bvibody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
BVI attributesPUTPOSTDELETEGET
    
"host-routing": "null" Enable host-routing on this BVI

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BVI - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Delete operation of resource: bvi

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BVI - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/bvi/

Retrieve operation of resource: bvi

active interface-name: string
in path

ID of active interface-name

200 OK
a3_bvi_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
BVI attributesPUTPOSTDELETEGET
    
"host-routing": "null" Enable host-routing on this BVI

  }
}

L2-TRANSPORT - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Update operation of resource: l2-transport

a3_l2-transport_schema

l2-transportbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
    
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
    : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

          
"l2-protocol-name": "string", Protocol name

          
"mode": "string" How to handle the protocol's packets

        }
      ]
    },
    
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
    : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
      
"egress-filtering": "string", Egress Ethernet filtering

      
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-TRANSPORT - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Create operation of resource: l2-transport

a3_l2-transport_schema

l2-transportbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
    
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
    : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

          
"l2-protocol-name": "string", Protocol name

          
"mode": "string" How to handle the protocol's packets

        }
      ]
    },
    
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
    : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
      
"egress-filtering": "string", Egress Ethernet filtering

      
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-TRANSPORT - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Delete operation of resource: l2-transport

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-TRANSPORT - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/

Retrieve operation of resource: l2-transport

active interface-name: string
in path

ID of active interface-name

200 OK
a3_l2-transport_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface Layer 2 Transport service\nconfiguration dataPUTPOSTDELETEGET
    
"propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state
    : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

          
"l2-protocol-name": "string", Protocol name

          
"mode": "string" How to handle the protocol's packets

        }
      ]
    },
    
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved.
    : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
      
"egress-filtering": "string", Egress Ethernet filtering

      
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

    }
  }
}

L2-PROTOCOLS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Update operation of resource: l2-protocols

a3_l2-protocols_schema

l2-protocolsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

        
"l2-protocol-name": "string", Protocol name

        
"mode": "string" How to handle the protocol's packets

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOLS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Create operation of resource: l2-protocols

a3_l2-protocols_schema

l2-protocolsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

        
"l2-protocol-name": "string", Protocol name

        
"mode": "string" How to handle the protocol's packets

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOLS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Delete operation of resource: l2-protocols

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOLS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/

Retrieve operation of resource: l2-protocols

active interface-name: string
in path

ID of active interface-name

200 OK
a3_l2-protocols_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface specific Layer 2 protocol handlingPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

        
"l2-protocol-name": "string", Protocol name

        
"mode": "string" How to handle the protocol's packets

      }
    ]
  }
}

L2-PROTOCOL - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Update operation of resource: l2-protocol

a3_l2-protocol_schema

l2-protocolbody object

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

      
"l2-protocol-name": "string", Protocol name

      
"mode": "string" How to handle the protocol's packets

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOL - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Create operation of resource: l2-protocol

a3_l2-protocol_schema

l2-protocolbody object

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

      
"l2-protocol-name": "string", Protocol name

      
"mode": "string" How to handle the protocol's packets

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOL - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Delete operation of resource: l2-protocol

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-PROTOCOL - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-protocols/l2-protocol/{l2-protocol-name}/

Retrieve operation of resource: l2-protocol

active interface-name: string
in path

ID of active interface-name

l2-protocol-name: string
in path

ID of l2-protocol-name

200 OK
a3_l2-protocol_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop

      
"l2-protocol-name": "string", Protocol name

      
"mode": "string" How to handle the protocol's packets

    }
  ]
}

L2-ETHERNET-FEATURES - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Update operation of resource: l2-ethernet-features

a3_l2-ethernet-features_schema

l2-ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
    
"egress-filtering": "string", Egress Ethernet filtering

    
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-ETHERNET-FEATURES - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Create operation of resource: l2-ethernet-features

a3_l2-ethernet-features_schema

l2-ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
    
"egress-filtering": "string", Egress Ethernet filtering

    
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-ETHERNET-FEATURES - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Delete operation of resource: l2-ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

L2-ETHERNET-FEATURES - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/l2-transport/l2-ethernet-features/

Retrieve operation of resource: l2-ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK
a3_l2-ethernet-features_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
L2 Ethernet Features ConfigurationPUTPOSTDELETEGET
    
"egress-filtering": "string", Egress Ethernet filtering

    
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter

  }
}

VLAN-SUB-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Update operation of resource: vlan-sub-configuration

a3_vlan-sub-configuration_schema

vlan-sub-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
    : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
      
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

      
"first-tag": "string", First (outermost) VLAN tag value

      
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-SUB-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Create operation of resource: vlan-sub-configuration

a3_vlan-sub-configuration_schema

vlan-sub-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
    : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
      
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

      
"first-tag": "string", First (outermost) VLAN tag value

      
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-SUB-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Delete operation of resource: vlan-sub-configuration

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-SUB-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/

Retrieve operation of resource: vlan-sub-configuration

active interface-name: string
in path

ID of active interface-name

200 OK
a3_vlan-sub-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IEEE 802.1Q VLAN subinterface configurationPUTPOSTDELETEGET
    : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
      
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

      
"first-tag": "string", First (outermost) VLAN tag value

      
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

    }
  }
}

VLAN-IDENTIFIER - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Update operation of resource: vlan-identifier

a3_vlan-identifier_schema

vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
    
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

    
"first-tag": "string", First (outermost) VLAN tag value

    
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-IDENTIFIER - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Create operation of resource: vlan-identifier

a3_vlan-identifier_schema

vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
    
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

    
"first-tag": "string", First (outermost) VLAN tag value

    
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-IDENTIFIER - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Delete operation of resource: vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-IDENTIFIER - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-sub-configuration/vlan-identifier/

Retrieve operation of resource: vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK
a3_vlan-identifier_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The VLAN tag stack associated with this\nsub-interface.PUTPOSTDELETEGET
    
"vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q

    
"first-tag": "string", First (outermost) VLAN tag value

    
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces

  }
}

ETHERNET-SERVICE - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Update operation of resource: ethernet-service

a3_ethernet-service_schema

ethernet-servicebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet service configurationPUTPOSTDELETEGET
    : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"outer-vlan-id": "string", VLAN id for outer tag

      
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

    },
    : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
      
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

      
"rewrite-type": "string", The type of rewrite to perform

      
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    },
    : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
      
"ingress-destination-mac": "string", Destination MAC address to match on egress

      
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

      
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

      
"inner-range1-high": "string", High value of first range for inner tag match

      
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

      
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

      
"outer-range1-low": "string", Low value of first range for outer tag match

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

      
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

      
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

      
"payload-ethertype-match": "string", Which payload ethertype values to match

      
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

      
"inner-range1-low": "string", Low value of first range for inner tag match

      
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

      
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

      
"additional-range3-high": "string", High value of third additional range for tag\nmatch

      
"ingress-source-mac": "string", Source MAC address to match on ingress

      
"outer-range1-high": "string", High value of first range for outer tag match

      
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

      
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

      
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

      
"additional-range2-high": "string", High value of second additional range for tag\nmatch

      
"exact": "null", Only match packets with no more tags than\nexplicitly matched

      
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

      
"additional-range1-high": "string" High value of first additional range for tag\nmatch

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-SERVICE - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Create operation of resource: ethernet-service

a3_ethernet-service_schema

ethernet-servicebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet service configurationPUTPOSTDELETEGET
    : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"outer-vlan-id": "string", VLAN id for outer tag

      
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

    },
    : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
      
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

      
"rewrite-type": "string", The type of rewrite to perform

      
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    },
    : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
      
"ingress-destination-mac": "string", Destination MAC address to match on egress

      
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

      
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

      
"inner-range1-high": "string", High value of first range for inner tag match

      
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

      
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

      
"outer-range1-low": "string", Low value of first range for outer tag match

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

      
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

      
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

      
"payload-ethertype-match": "string", Which payload ethertype values to match

      
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

      
"inner-range1-low": "string", Low value of first range for inner tag match

      
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

      
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

      
"additional-range3-high": "string", High value of third additional range for tag\nmatch

      
"ingress-source-mac": "string", Source MAC address to match on ingress

      
"outer-range1-high": "string", High value of first range for outer tag match

      
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

      
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

      
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

      
"additional-range2-high": "string", High value of second additional range for tag\nmatch

      
"exact": "null", Only match packets with no more tags than\nexplicitly matched

      
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

      
"additional-range1-high": "string" High value of first additional range for tag\nmatch

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-SERVICE - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Delete operation of resource: ethernet-service

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-SERVICE - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/

Retrieve operation of resource: ethernet-service

active interface-name: string
in path

ID of active interface-name

200 OK
a3_ethernet-service_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Ethernet service configurationPUTPOSTDELETEGET
    : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"outer-vlan-id": "string", VLAN id for outer tag

      
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

    },
    : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
      
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

      
"rewrite-type": "string", The type of rewrite to perform

      
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    },
    : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
      
"ingress-destination-mac": "string", Destination MAC address to match on egress

      
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

      
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

      
"inner-range1-high": "string", High value of first range for inner tag match

      
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

      
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

      
"outer-range1-low": "string", Low value of first range for outer tag match

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

      
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

      
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

      
"payload-ethertype-match": "string", Which payload ethertype values to match

      
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

      
"inner-range1-low": "string", Low value of first range for inner tag match

      
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

      
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

      
"additional-range3-high": "string", High value of third additional range for tag\nmatch

      
"ingress-source-mac": "string", Source MAC address to match on ingress

      
"outer-range1-high": "string", High value of first range for outer tag match

      
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

      
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

      
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

      
"additional-range2-high": "string", High value of second additional range for tag\nmatch

      
"exact": "null", Only match packets with no more tags than\nexplicitly matched

      
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

      
"additional-range1-high": "string" High value of first additional range for tag\nmatch

    }
  }
}

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Update operation of resource: local-traffic-default-encapsulation

a3_local-traffic-default-encapsulation_schema

local-traffic-default-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
    
"outer-tag-type": "string", Type of outer tag

    
"outer-vlan-id": "string", VLAN id for outer tag

    
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Create operation of resource: local-traffic-default-encapsulation

a3_local-traffic-default-encapsulation_schema

local-traffic-default-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
    
"outer-tag-type": "string", Type of outer tag

    
"outer-vlan-id": "string", VLAN id for outer tag

    
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Delete operation of resource: local-traffic-default-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/local-traffic-default-encapsulation/

Retrieve operation of resource: local-traffic-default-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a3_local-traffic-default-encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The default encapsulation to be used for\nlocally-sourced packetsPUTPOSTDELETEGET
    
"outer-tag-type": "string", Type of outer tag

    
"outer-vlan-id": "string", VLAN id for outer tag

    
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag

  }
}

ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Update operation of resource: encapsulation

a3_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Create operation of resource: encapsulation

a3_encapsulation_schema

encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Delete operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/encapsulation/

Retrieve operation of resource: encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a3_encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The encapsulation of this Ethernet servicePUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}

REWRITE - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Update operation of resource: rewrite

a3_rewrite_schema

rewritebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
    
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

    
"rewrite-type": "string", The type of rewrite to perform

    
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

    
"inner-tag-type": "string", Type of innermost tag to be pushed

    
"outer-tag-type": "string" Type of outermost tag to be pushed

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REWRITE - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Create operation of resource: rewrite

a3_rewrite_schema

rewritebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
    
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

    
"rewrite-type": "string", The type of rewrite to perform

    
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

    
"inner-tag-type": "string", Type of innermost tag to be pushed

    
"outer-tag-type": "string" Type of outermost tag to be pushed

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REWRITE - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Delete operation of resource: rewrite

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REWRITE - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-service/rewrite/

Retrieve operation of resource: rewrite

active interface-name: string
in path

ID of active interface-name

200 OK
a3_rewrite_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The rewrite operation for the Ethernet servicePUTPOSTDELETEGET
    
"inner-tag-value": "string", VLAN Id of innermost tag to be pushed

    
"rewrite-type": "string", The type of rewrite to perform

    
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed

    
"inner-tag-type": "string", Type of innermost tag to be pushed

    
"outer-tag-type": "string" Type of outermost tag to be pushed

  }
}

ETHERNET-BNG - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Update operation of resource: ethernet-bng

a3_ethernet-bng_schema

ethernet-bngbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
    : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
      
"ingress-destination-mac": "string", Destination MAC address to match on egress

      
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

      
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

      
"inner-range1-high": "string", High value of first range for inner tag match

      
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

      
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

      
"outer-range1-low": "string", Low value of first range for outer tag match

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

      
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

      
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

      
"payload-ethertype-match": "string", Which payload ethertype values to match

      
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

      
"inner-range1-low": "string", Low value of first range for inner tag match

      
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

      
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

      
"additional-range3-high": "string", High value of third additional range for tag\nmatch

      
"ingress-source-mac": "string", Source MAC address to match on ingress

      
"outer-range1-high": "string", High value of first range for outer tag match

      
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

      
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

      
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

      
"additional-range2-high": "string", High value of second additional range for tag\nmatch

      
"exact": "null", Only match packets with no more tags than\nexplicitly matched

      
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

      
"additional-range1-high": "string" High value of first additional range for tag\nmatch

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-BNG - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Create operation of resource: ethernet-bng

a3_ethernet-bng_schema

ethernet-bngbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
    : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
      
"ingress-destination-mac": "string", Destination MAC address to match on egress

      
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

      
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

      
"inner-range1-high": "string", High value of first range for inner tag match

      
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

      
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

      
"outer-range1-low": "string", Low value of first range for outer tag match

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

      
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

      
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

      
"payload-ethertype-match": "string", Which payload ethertype values to match

      
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

      
"inner-range1-low": "string", Low value of first range for inner tag match

      
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

      
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

      
"additional-range3-high": "string", High value of third additional range for tag\nmatch

      
"ingress-source-mac": "string", Source MAC address to match on ingress

      
"outer-range1-high": "string", High value of first range for outer tag match

      
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

      
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

      
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

      
"additional-range2-high": "string", High value of second additional range for tag\nmatch

      
"exact": "null", Only match packets with no more tags than\nexplicitly matched

      
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

      
"additional-range1-high": "string" High value of first additional range for tag\nmatch

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-BNG - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Delete operation of resource: ethernet-bng

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-BNG - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/

Retrieve operation of resource: ethernet-bng

active interface-name: string
in path

ID of active interface-name

200 OK
a3_ethernet-bng_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Ethernet Infra BNG specific configurationPUTPOSTDELETEGET
    : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
      
"ingress-destination-mac": "string", Destination MAC address to match on egress

      
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

      
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

      
"inner-range1-high": "string", High value of first range for inner tag match

      
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

      
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

      
"outer-range1-low": "string", Low value of first range for outer tag match

      
"inner-tag-type": "string", Type of tag for inner match (if present)

      
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

      
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

      
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

      
"payload-ethertype-match": "string", Which payload ethertype values to match

      
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

      
"inner-range1-low": "string", Low value of first range for inner tag match

      
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

      
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

      
"additional-range3-high": "string", High value of third additional range for tag\nmatch

      
"ingress-source-mac": "string", Source MAC address to match on ingress

      
"outer-range1-high": "string", High value of first range for outer tag match

      
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

      
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

      
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

      
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

      
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

      
"additional-range2-high": "string", High value of second additional range for tag\nmatch

      
"exact": "null", Only match packets with no more tags than\nexplicitly matched

      
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

      
"additional-range1-high": "string" High value of first additional range for tag\nmatch

    }
  }
}

AMBIGUOUS-ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Update operation of resource: ambiguous-encapsulation

a3_ambiguous-encapsulation_schema

ambiguous-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMBIGUOUS-ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Create operation of resource: ambiguous-encapsulation

a3_ambiguous-encapsulation_schema

ambiguous-encapsulationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMBIGUOUS-ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Delete operation of resource: ambiguous-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMBIGUOUS-ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-bng/ambiguous-encapsulation/

Retrieve operation of resource: ambiguous-encapsulation

active interface-name: string
in path

ID of active interface-name

200 OK
a3_ambiguous-encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
L3 Ambiguous encapsulationPUTPOSTDELETEGET
    
"ingress-destination-mac": "string", Destination MAC address to match on egress

    
"additional-range4-high": "string", High value of forth additional range for tag\nmatch

    
"additional-range1-low": "string", Low value of first additional range for tag\nmatch

    
"inner-range1-high": "string", High value of first range for inner tag match

    
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch

    
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch

    
"outer-range1-low": "string", Low value of first range for outer tag match

    
"inner-tag-type": "string", Type of tag for inner match (if present)

    
"additional-range3-low": "string", Low value of third additional range for tag\nmatch

    
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag

    
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch

    
"payload-ethertype-match": "string", Which payload ethertype values to match

    
"additional-range2-low": "string", Low value of second additional range for tag\nmatch

    
"inner-range1-low": "string", Low value of first range for inner tag match

    
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch

    
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag

    
"additional-range3-high": "string", High value of third additional range for tag\nmatch

    
"ingress-source-mac": "string", Source MAC address to match on ingress

    
"outer-range1-high": "string", High value of first range for outer tag match

    
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch

    
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch

    
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch

    
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch

    
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch

    
"additional-range2-high": "string", High value of second additional range for tag\nmatch

    
"exact": "null", Only match packets with no more tags than\nexplicitly matched

    
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch

    
"additional-range1-high": "string" High value of first additional range for tag\nmatch

  }
}

MAC-ACCOUNTING - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Update operation of resource: mac-accounting

a3_mac-accounting_schema

mac-accountingbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
    
"ingress": "null", Per MAC address accounting statistics

    
"egress": "null" Per MAC address accounting statistics

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-ACCOUNTING - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Create operation of resource: mac-accounting

a3_mac-accounting_schema

mac-accountingbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
    
"ingress": "null", Per MAC address accounting statistics

    
"egress": "null" Per MAC address accounting statistics

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-ACCOUNTING - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Delete operation of resource: mac-accounting

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-ACCOUNTING - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mac-accounting/

Retrieve operation of resource: mac-accounting

active interface-name: string
in path

ID of active interface-name

200 OK
a3_mac-accounting_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
MAC Accounting ConfigurationPUTPOSTDELETEGET
    
"ingress": "null", Per MAC address accounting statistics

    
"egress": "null" Per MAC address accounting statistics

  }
}

ETHERNET-FEATURES - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Update operation of resource: ethernet-features

a3_ethernet-features_schema

ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
    
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
    : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
      : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
        : {
Frame-seconds event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Symbol-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        },
        
"monitoring": "boolean", Enable or disable monitoring
        : {
Frame event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Frame-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        }
      },
      
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

      
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

      
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

      
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

      
"mode": "string", Possible required peer modes

      
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
      : {
Configure action parametersPUTPOSTDELETEGET
        
"dying-gasp": "string", Action to perform when a dying gasp occurs

        
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

        
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

        
"session-up": "string", Action to perform when a session comes up

        
"critical-event": "string", Action to perform when a critical event occurs

        
"link-fault": "string", Action to perform when a link fault occurs

        
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

        
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

        
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

        
"session-down": "string" Action to perform when a session comes down

      },
      : {
Configure remote requirement parametersPUTPOSTDELETEGET
        
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

        
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

        
"mode": "string", Possible required peer modes

        
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

      },
      
"profile-name": "string" Set the profile to use on the interface

    },
    
"filtering": "string" Ingress Ethernet frame filtering

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Create operation of resource: ethernet-features

a3_ethernet-features_schema

ethernet-featuresbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
    
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
    : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
      : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
        : {
Frame-seconds event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Symbol-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        },
        
"monitoring": "boolean", Enable or disable monitoring
        : {
Frame event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Frame-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        }
      },
      
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

      
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

      
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

      
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

      
"mode": "string", Possible required peer modes

      
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
      : {
Configure action parametersPUTPOSTDELETEGET
        
"dying-gasp": "string", Action to perform when a dying gasp occurs

        
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

        
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

        
"session-up": "string", Action to perform when a session comes up

        
"critical-event": "string", Action to perform when a critical event occurs

        
"link-fault": "string", Action to perform when a link fault occurs

        
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

        
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

        
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

        
"session-down": "string" Action to perform when a session comes down

      },
      : {
Configure remote requirement parametersPUTPOSTDELETEGET
        
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

        
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

        
"mode": "string", Possible required peer modes

        
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

      },
      
"profile-name": "string" Set the profile to use on the interface

    },
    
"filtering": "string" Ingress Ethernet frame filtering

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Delete operation of resource: ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHERNET-FEATURES - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/

Retrieve operation of resource: ethernet-features

active interface-name: string
in path

ID of active interface-name

200 OK
a3_ethernet-features_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Ethernet Features ConfigurationPUTPOSTDELETEGET
    
"ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface
    : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
      : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
        : {
Frame-seconds event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Symbol-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        },
        
"monitoring": "boolean", Enable or disable monitoring
        : {
Frame event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        },
        : {
Frame-period event configurationPUTPOSTDELETEGET
          : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
            
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

            
"units": "string", The units to use for this window

            
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

            
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

            
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          },
          : {
Size of the frame-period windowPUTPOSTDELETEGET
            
"units": "string", The units to use for this window

            
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

            
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

          }
        }
      },
      
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

      
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

      
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

      
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

      
"mode": "string", Possible required peer modes

      
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
      : {
Configure action parametersPUTPOSTDELETEGET
        
"dying-gasp": "string", Action to perform when a dying gasp occurs

        
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

        
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

        
"session-up": "string", Action to perform when a session comes up

        
"critical-event": "string", Action to perform when a critical event occurs

        
"link-fault": "string", Action to perform when a link fault occurs

        
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

        
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

        
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

        
"session-down": "string" Action to perform when a session comes down

      },
      : {
Configure remote requirement parametersPUTPOSTDELETEGET
        
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

        
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

        
"mode": "string", Possible required peer modes

        
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

      },
      
"profile-name": "string" Set the profile to use on the interface

    },
    
"filtering": "string" Ingress Ethernet frame filtering

  }
}

ETHER-LINK-OAM - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/

Update operation of resource: ether-link-oam

a3_ether-link-oam_schema

ether-link-oambody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
    : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
      : {
Frame-seconds event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        },
        
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      },
      : {
Symbol-period event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"units": "string", The units to use for this window

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        : {
Size of the frame-period windowPUTPOSTDELETEGET
          
"units": "string", The units to use for this window

          
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

        }
      },
      
"monitoring": "boolean", Enable or disable monitoring
      : {
Frame event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      },
      : {
Frame-period event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"units": "string", The units to use for this window

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        : {
Size of the frame-period windowPUTPOSTDELETEGET
          
"units": "string", The units to use for this window

          
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

        }
      }
    },
    
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

    
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

    
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

    
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

    
"mode": "string", Possible required peer modes

    
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
    : {
Configure action parametersPUTPOSTDELETEGET
      
"dying-gasp": "string", Action to perform when a dying gasp occurs

      
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

      
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

      
"session-up": "string", Action to perform when a session comes up

      
"critical-event": "string", Action to perform when a critical event occurs

      
"link-fault": "string", Action to perform when a link fault occurs

      
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

      
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

      
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

      
"session-down": "string" Action to perform when a session comes down

    },
    : {
Configure remote requirement parametersPUTPOSTDELETEGET
      
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

      
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

      
"mode": "string", Possible required peer modes

      
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

    },
    
"profile-name": "string" Set the profile to use on the interface

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHER-LINK-OAM - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/

Create operation of resource: ether-link-oam

a3_ether-link-oam_schema

ether-link-oambody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
    : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
      : {
Frame-seconds event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        },
        
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      },
      : {
Symbol-period event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"units": "string", The units to use for this window

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        : {
Size of the frame-period windowPUTPOSTDELETEGET
          
"units": "string", The units to use for this window

          
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

        }
      },
      
"monitoring": "boolean", Enable or disable monitoring
      : {
Frame event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      },
      : {
Frame-period event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"units": "string", The units to use for this window

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        : {
Size of the frame-period windowPUTPOSTDELETEGET
          
"units": "string", The units to use for this window

          
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

        }
      }
    },
    
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

    
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

    
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

    
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

    
"mode": "string", Possible required peer modes

    
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
    : {
Configure action parametersPUTPOSTDELETEGET
      
"dying-gasp": "string", Action to perform when a dying gasp occurs

      
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

      
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

      
"session-up": "string", Action to perform when a session comes up

      
"critical-event": "string", Action to perform when a critical event occurs

      
"link-fault": "string", Action to perform when a link fault occurs

      
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

      
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

      
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

      
"session-down": "string" Action to perform when a session comes down

    },
    : {
Configure remote requirement parametersPUTPOSTDELETEGET
      
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

      
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

      
"mode": "string", Possible required peer modes

      
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

    },
    
"profile-name": "string" Set the profile to use on the interface

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHER-LINK-OAM - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/

Delete operation of resource: ether-link-oam

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ETHER-LINK-OAM - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/

Retrieve operation of resource: ether-link-oam

active interface-name: string
in path

ID of active interface-name

200 OK
a3_ether-link-oam_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Ethernet Link OAM Interface ConfigurationPUTPOSTDELETEGET
    : {
Enable or disable link monitoring peer\nrequirementPUTPOSTDELETEGET
      : {
Frame-seconds event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        },
        
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      },
      : {
Symbol-period event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"units": "string", The units to use for this window

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        : {
Size of the frame-period windowPUTPOSTDELETEGET
          
"units": "string", The units to use for this window

          
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

        }
      },
      
"monitoring": "boolean", Enable or disable monitoring
      : {
Frame event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      },
      : {
Frame-period event configurationPUTPOSTDELETEGET
        : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
          
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

          
"units": "string", The units to use for this window

          
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

          
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

          
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        },
        : {
Size of the frame-period windowPUTPOSTDELETEGET
          
"units": "string", The units to use for this window

          
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

          
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

        }
      }
    },
    
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection

    
"hello-interval": "string", Possible Ethernet Link OAM hello intervals

    
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement

    
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

    
"mode": "string", Possible required peer modes

    
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond"
    : {
Configure action parametersPUTPOSTDELETEGET
      
"dying-gasp": "string", Action to perform when a dying gasp occurs

      
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

      
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement

      
"session-up": "string", Action to perform when a session comes up

      
"critical-event": "string", Action to perform when a critical event occurs

      
"link-fault": "string", Action to perform when a link fault occurs

      
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

      
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

      
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

      
"session-down": "string" Action to perform when a session comes down

    },
    : {
Configure remote requirement parametersPUTPOSTDELETEGET
      
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

      
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

      
"mode": "string", Possible required peer modes

      
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

    },
    
"profile-name": "string" Set the profile to use on the interface

  }
}

ACTION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/action/

Update operation of resource: action

a3_action_schema

actionbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure action parametersPUTPOSTDELETEGET
    
"dying-gasp": "string", Action to perform when a dying gasp occurs

    
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

    
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited

    
"session-up": "string", Action to perform when a session comes up

    
"critical-event": "string", Action to perform when a critical event occurs

    
"link-fault": "string", Action to perform when a link fault occurs

    
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

    
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

    
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

    
"session-down": "string" Action to perform when a session comes down

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/action/

Create operation of resource: action

a3_action_schema

actionbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure action parametersPUTPOSTDELETEGET
    
"dying-gasp": "string", Action to perform when a dying gasp occurs

    
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

    
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited

    
"session-up": "string", Action to perform when a session comes up

    
"critical-event": "string", Action to perform when a critical event occurs

    
"link-fault": "string", Action to perform when a link fault occurs

    
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

    
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

    
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

    
"session-down": "string" Action to perform when a session comes down

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/action/

Delete operation of resource: action

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/action/

Retrieve operation of resource: action

active interface-name: string
in path

ID of active interface-name

200 OK
a3_action_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure action parametersPUTPOSTDELETEGET
    
"dying-gasp": "string", Action to perform when a dying gasp occurs

    
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs

    
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited

    
"session-up": "string", Action to perform when a session comes up

    
"critical-event": "string", Action to perform when a critical event occurs

    
"link-fault": "string", Action to perform when a link fault occurs

    
"high-threshold": "string", Action to perform when a high-threshold event\noccurs

    
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs

    
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs

    
"session-down": "string" Action to perform when a session comes down

  }
}

REQUIRE-REMOTE - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/require-remote/

Update operation of resource: require-remote

a3_require-remote_schema

require-remotebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure remote requirement parametersPUTPOSTDELETEGET
    
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

    
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

    
"mode": "string", Possible required peer modes

    
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUIRE-REMOTE - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/require-remote/

Create operation of resource: require-remote

a3_require-remote_schema

require-remotebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure remote requirement parametersPUTPOSTDELETEGET
    
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

    
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

    
"mode": "string", Possible required peer modes

    
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUIRE-REMOTE - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/require-remote/

Delete operation of resource: require-remote

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUIRE-REMOTE - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/require-remote/

Retrieve operation of resource: require-remote

active interface-name: string
in path

ID of active interface-name

200 OK
a3_require-remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure remote requirement parametersPUTPOSTDELETEGET
    
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement

    
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement

    
"mode": "string", Possible required peer modes

    
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement

  }
}

LINK-MONITORING - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/

Update operation of resource: link-monitoring

a3_link-monitoring_schema

link-monitoringbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure link monitor parametersPUTPOSTDELETEGET
    : {
Frame-seconds event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Symbol-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    },
    
"monitoring": "boolean", Enable or disable monitoring
    : {
Frame event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Frame-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-MONITORING - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/

Create operation of resource: link-monitoring

a3_link-monitoring_schema

link-monitoringbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure link monitor parametersPUTPOSTDELETEGET
    : {
Frame-seconds event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Symbol-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    },
    
"monitoring": "boolean", Enable or disable monitoring
    : {
Frame event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Frame-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-MONITORING - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/

Delete operation of resource: link-monitoring

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-MONITORING - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/

Retrieve operation of resource: link-monitoring

active interface-name: string
in path

ID of active interface-name

200 OK
a3_link-monitoring_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure link monitor parametersPUTPOSTDELETEGET
    : {
Frame-seconds event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Symbol-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    },
    
"monitoring": "boolean", Enable or disable monitoring
    : {
Frame event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    },
    : {
Frame-period event configurationPUTPOSTDELETEGET
      : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
        
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

        
"units": "string", The units to use for this window

        
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

        
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

        
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      },
      : {
Size of the frame-period windowPUTPOSTDELETEGET
        
"units": "string", The units to use for this window

        
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

        
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

      }
    }
  }
}

SYMBOL-PERIOD - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/

Update operation of resource: symbol-period

a3_symbol-period_schema

symbol-periodbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Symbol-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for symbol-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"

      
"units": "string", Units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

    },
    : {
Size of the symbol-period windowPUTPOSTDELETEGET
      
"units": "string", Units to use for this window

      
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYMBOL-PERIOD - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/

Create operation of resource: symbol-period

a3_symbol-period_schema

symbol-periodbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Symbol-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for symbol-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"

      
"units": "string", Units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

    },
    : {
Size of the symbol-period windowPUTPOSTDELETEGET
      
"units": "string", Units to use for this window

      
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYMBOL-PERIOD - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/

Delete operation of resource: symbol-period

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYMBOL-PERIOD - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/

Retrieve operation of resource: symbol-period

active interface-name: string
in path

ID of active interface-name

200 OK
a3_symbol-period_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Symbol-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for symbol-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"

      
"units": "string", Units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)

    },
    : {
Size of the symbol-period windowPUTPOSTDELETEGET
      
"units": "string", Units to use for this window

      
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)

    }
  }
}

WINDOW - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/window/

Update operation of resource: window

a3_window_schema

windowbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/window/

Create operation of resource: window

a3_window_schema

windowbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/window/

Delete operation of resource: window

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/window/

Retrieve operation of resource: window

active interface-name: string
in path

ID of active interface-name

200 OK
a3_window_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/threshold/

Update operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/threshold/

Create operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/threshold/

Delete operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/symbol-period/threshold/

Retrieve operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK
a3_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

FRAME-PERIOD - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/

Update operation of resource: frame-period

a3_frame-period_schema

frame-periodbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Frame-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

      
"units": "string", The units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

    },
    : {
Size of the frame-period windowPUTPOSTDELETEGET
      
"units": "string", The units to use for this window

      
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-PERIOD - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/

Create operation of resource: frame-period

a3_frame-period_schema

frame-periodbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Frame-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

      
"units": "string", The units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

    },
    : {
Size of the frame-period windowPUTPOSTDELETEGET
      
"units": "string", The units to use for this window

      
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-PERIOD - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/

Delete operation of resource: frame-period

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-PERIOD - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/

Retrieve operation of resource: frame-period

active interface-name: string
in path

ID of active interface-name

200 OK
a3_frame-period_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Frame-period event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-period\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"

      
"units": "string", The units to use for this window

      
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

      
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"

      
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)

    },
    : {
Size of the frame-period windowPUTPOSTDELETEGET
      
"units": "string", The units to use for this window

      
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

      
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

    }
  }
}

WINDOW - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/window/

Update operation of resource: window

a3_window_schema

windowbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/window/

Create operation of resource: window

a3_window_schema

windowbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/window/

Delete operation of resource: window

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WINDOW - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/window/

Retrieve operation of resource: window

active interface-name: string
in path

ID of active interface-name

200 OK
a3_window_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Size of the frame-period windowPUTPOSTDELETEGET
    
"units": "string", The units to use for this window

    
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"

    
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)

  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/threshold/

Update operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/threshold/

Create operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/threshold/

Delete operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-period/threshold/

Retrieve operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK
a3_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

FRAME-SECONDS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/

Update operation of resource: frame-seconds

a3_frame-seconds_schema

frame-secondsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Frame-seconds event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-seconds\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

      
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

    },
    
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-SECONDS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/

Create operation of resource: frame-seconds

a3_frame-seconds_schema

frame-secondsbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Frame-seconds event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-seconds\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

      
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

    },
    
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-SECONDS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/

Delete operation of resource: frame-seconds

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME-SECONDS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/

Retrieve operation of resource: frame-seconds

active interface-name: string
in path

ID of active interface-name

200 OK
a3_frame-seconds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Frame-seconds event configurationPUTPOSTDELETEGET
    : {
Threshold configuration for frame-seconds\neventsPUTPOSTDELETEGET
      
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

      
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

    },
    
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/threshold/

Update operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/threshold/

Create operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/threshold/

Delete operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame-seconds/threshold/

Retrieve operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK
a3_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

FRAME - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/

Update operation of resource: frame

a3_frame_schema

framebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame-seconds\nevents
    
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

    
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

  },
  
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/

Create operation of resource: frame

a3_frame_schema

framebody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame-seconds\nevents
    
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

    
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

  },
  
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/

Delete operation of resource: frame

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FRAME - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/

Retrieve operation of resource: frame

active interface-name: string
in path

ID of active interface-name

200 OK
a3_frame_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame-seconds\nevents
    
"threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"

    
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"

  },
  
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"

}

THRESHOLD - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/threshold/

Update operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/threshold/

Create operation of resource: threshold

a3_threshold_schema

thresholdbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/threshold/

Delete operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/ethernet-features/ether-link-oam/link-monitoring/frame/threshold/

Retrieve operation of resource: threshold

active interface-name: string
in path

ID of active interface-name

200 OK
a3_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Threshold configuration for frame eventsPUTPOSTDELETEGET
    
"threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"

    
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)

    
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"

    
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)

  }
}

CARRIER-DELAY - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Update operation of resource: carrier-delay

a3_carrier-delay_schema

carrier-delaybody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
    
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

    
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CARRIER-DELAY - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Create operation of resource: carrier-delay

a3_carrier-delay_schema

carrier-delaybody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
    
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

    
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CARRIER-DELAY - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Delete operation of resource: carrier-delay

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CARRIER-DELAY - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/carrier-delay/

Retrieve operation of resource: carrier-delay

active interface-name: string
in path

ID of active interface-name

200 OK
a3_carrier-delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Set the carrier transition delay on an interface\nin msecsPUTPOSTDELETEGET
    
"carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"

    
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0

  }
}

VLAN-TRUNK-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Update operation of resource: vlan-trunk-configuration

a3_vlan-trunk-configuration_schema

vlan-trunk-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
    : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
      
"vlan-type": "string", Whether this interface is dot1ad or dot1Q

      
"vlan-identifier": "string" VLAN identifier

    },
    
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-TRUNK-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Create operation of resource: vlan-trunk-configuration

a3_vlan-trunk-configuration_schema

vlan-trunk-configurationbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
    : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
      
"vlan-type": "string", Whether this interface is dot1ad or dot1Q

      
"vlan-identifier": "string" VLAN identifier

    },
    
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-TRUNK-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Delete operation of resource: vlan-trunk-configuration

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VLAN-TRUNK-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/

Retrieve operation of resource: vlan-trunk-configuration

active interface-name: string
in path

ID of active interface-name

200 OK
a3_vlan-trunk-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IEEE 802.1Q VLAN trunk interface configurationPUTPOSTDELETEGET
    : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
      
"vlan-type": "string", Whether this interface is dot1ad or dot1Q

      
"vlan-identifier": "string" VLAN identifier

    },
    
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100

  }
}

NATIVE-VLAN-IDENTIFIER - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Update operation of resource: native-vlan-identifier

a3_native-vlan-identifier_schema

native-vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
    
"vlan-type": "string", Whether this interface is dot1ad or dot1Q

    
"vlan-identifier": "string" VLAN identifier

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NATIVE-VLAN-IDENTIFIER - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Create operation of resource: native-vlan-identifier

a3_native-vlan-identifier_schema

native-vlan-identifierbody object

active interface-name: string
in path

ID of active interface-name

Request Content-Types: application/json
Request Example
{
  : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
    
"vlan-type": "string", Whether this interface is dot1ad or dot1Q

    
"vlan-identifier": "string" VLAN identifier

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NATIVE-VLAN-IDENTIFIER - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Delete operation of resource: native-vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NATIVE-VLAN-IDENTIFIER - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/vlan-trunk-configuration/native-vlan-identifier/

Retrieve operation of resource: native-vlan-identifier

active interface-name: string
in path

ID of active interface-name

200 OK
a3_native-vlan-identifier_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The Native VLAN identifier associated with this\ntrunk interfacePUTPOSTDELETEGET
    
"vlan-type": "string", Whether this interface is dot1ad or dot1Q

    
"vlan-identifier": "string" VLAN identifier

  }
}